Microsoft.ProviderHub (stable:2024-09-01)

2025/05/29 • 60 new methods

CustomRollouts_Get (new)
Description :  Gets the custom rollout details.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/customRollouts/{rolloutName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
rolloutName:
{
Description: The rollout name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the rollout. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: The specification. ,
Required: True ,
}
string ,
status:
{
Description: The status. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CustomRollouts_Delete (new)
Description :  Deletes the custom rollout resource. Custom rollout must be in terminal state.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/customRollouts/{rolloutName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
rolloutName:
{
Description: The rollout name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CustomRollouts_CreateOrUpdate (new)
Description :  Creates or updates the rollout details.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/customRollouts/{rolloutName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
rolloutName:
{
Description: The rollout name. ,
Required: True ,
}
string ,
properties:
{
Description: The custom rollout properties supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of the rollout. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: The specification. ,
Required: True ,
}
string ,
status:
{
Description: The status. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the rollout. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: The specification. ,
Required: True ,
}
string ,
status:
{
Description: The status. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the rollout. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: The specification. ,
Required: True ,
}
string ,
status:
{
Description: The status. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CustomRollouts_ListByProviderRegistration (new)
Description :  Gets the list of the custom rollouts for the given provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/customRollouts
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: Properties of the rollout. ,
Required: True ,
}
{
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: The specification. ,
Required: True ,
}
string ,
status:
{
Description: The status. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get to the next set of results, if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CustomRollouts_Stop (new)
Description :  Stops or cancels the custom rollout, if in progress.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/customRollouts/{rolloutName}/stop
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
rolloutName:
{
Description: The rollout name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DefaultRollouts_Get (new)
Description :  Gets the default rollout details.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/defaultRollouts/{rolloutName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
rolloutName:
{
Description: The rollout name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the rollout. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: The default rollout specification. ,
Required: False ,
}
string ,
status:
{
Description: The default rollout status. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DefaultRollouts_Delete (new)
Description :  Deletes the rollout resource. Rollout must be in terminal state.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/defaultRollouts/{rolloutName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
rolloutName:
{
Description: The rollout name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DefaultRollouts_CreateOrUpdate (new)
Description :  Creates or updates the rollout details.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/defaultRollouts/{rolloutName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
rolloutName:
{
Description: The rollout name. ,
Required: True ,
}
string ,
properties:
{
Description: The Default rollout properties supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
properties:
{
Description: Properties of the rollout. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: The default rollout specification. ,
Required: False ,
}
string ,
status:
{
Description: The default rollout status. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the rollout. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: The default rollout specification. ,
Required: False ,
}
string ,
status:
{
Description: The default rollout status. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the rollout. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: The default rollout specification. ,
Required: False ,
}
string ,
status:
{
Description: The default rollout status. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DefaultRollouts_ListByProviderRegistration (new)
Description :  Gets the list of the rollouts for the given provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/defaultRollouts
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Description: Properties of the rollout. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: The default rollout specification. ,
Required: False ,
}
string ,
status:
{
Description: The default rollout status. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get to the next set of results, if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
DefaultRollouts_Stop (new)
Description :  Stops or cancels the rollout, if in progress.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/defaultRollouts/{rolloutName}/stop
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
rolloutName:
{
Description: The rollout name. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
GenerateManifest (new)
Description :  Generates the manifest for the given provider.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/generateManifest
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
providerAuthentication:
{
Description: The provider authentication. ,
Required: False ,
}
string ,
providerAuthorizations:
{
Description: The provider authorizations. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application id. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The role definition id. ,
Required: False ,
}
string ,
managedByRoleDefinitionId:
{
Description: The managed by role definition id. ,
Required: False ,
}
string ,
managedByAuthorization:
{
Description: Managed by authorization. ,
Required: False ,
}
{
additionalAuthorizations:
{
Required: False ,
}
[
{
applicationId:
{
Required: False ,
}
string ,
roleDefinitionId:
{
Required: False ,
}
string ,
}
,
]
,
managedByResourceRoleDefinitionId:
{
Description: The managed by resource role definition ID for the application. ,
Required: False ,
}
string ,
allowManagedByInheritance:
{
Description: Indicates whether the managed by resource role definition ID should be inherited. ,
Required: False ,
}
boolean ,
}
,
allowedThirdPartyExtensions:
{
Description: The allowed third party extensions. ,
Required: False ,
}
[
{
name:
{
Description: Name of third party extension. ,
Required: False ,
}
string ,
}
,
]
,
groupingTag:
{
Description: The grouping tag. ,
Required: False ,
}
string ,
}
,
]
,
namespace:
{
Description: The namespace. ,
Required: False ,
}
string ,
services:
{
Description: The services. ,
Required: False ,
}
[
{
serviceName:
{
Description: The service name. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
serviceName:
{
Description: The service name. ,
Required: False ,
}
string ,
providerVersion:
{
Description: The provider version. ,
Required: False ,
}
string ,
providerType:
{
Description: The provider type. ,
Enum:
{
NotSpecified: No description available. ,
Internal: No description available. ,
External: No description available. ,
Hidden: No description available. ,
RegistrationFree: No description available. ,
LegacyRegistrationRequired: No description available. ,
TenantOnly: No description available. ,
AuthorizationFree: No description available. ,
}
,
Required: False ,
}
enum ,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
featuresRule:
{
Description: The features rule. ,
Required: False ,
}
string ,
requestHeaderOptions:
{
Description: The request header options. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The resource types. ,
Required: False ,
}
[
{
name:
{
Description: The resource type name. ,
Required: False ,
}
string ,
routingType:
{
Description: The resource routing type. ,
Enum:
{
Default: The resource routing type is default. ,
ProxyOnly: The resource routing type is proxy only. ,
HostBased: The resource routing type is host based. ,
Extension: The resource routing type is extension. ,
Tenant: The resource routing type is tenant. ,
Fanout: The resource routing type is fanout. ,
LocationBased: The resource routing type is location based. ,
Failover: The resource routing type is failover. ,
CascadeExtension: The resource routing type is cascade extension. ,
ChildFanout: The resource routing type is child fanout. ,
CascadeAuthorizedExtension: The resource routing type is cascade authorized extension. ,
BypassEndpointSelectionOptimization: The resource routing type is bypass endpoint selection optimization. ,
LocationMapping: The resource routing type is location mapping. ,
ServiceFanout: The resource routing type is service fanout. ,
}
,
Required: False ,
}
enum ,
additionalOptions:
{
Description: The additional options. ,
Enum:
{
ProtectedAsyncOperationPolling: No description available. ,
ProtectedAsyncOperationPollingAuditOnly: No description available. ,
}
,
Required: False ,
}
enum ,
crossTenantTokenValidation:
{
Description: The cross tenant token validation. ,
Enum:
{
EnsureSecureValidation: No description available. ,
PassthroughInsecureToken: No description available. ,
}
,
Required: False ,
}
enum ,
resourceValidation:
{
Description: The resource validation. ,
Enum:
{
NotSpecified: No description available. ,
ReservedWords: No description available. ,
ProfaneWords: No description available. ,
}
,
Required: False ,
}
enum ,
allowedUnauthorizedActions:
{
Description: The allowed unauthorized actions. ,
Required: False ,
}
[
string ,
]
,
allowedUnauthorizedActionsExtensions:
{
Description: The allowed unauthorized actions extensions. ,
Required: False ,
}
[
{
action:
{
Description: The action. ,
Required: False ,
}
string ,
intent:
{
Description: The intent. ,
Enum:
{
NOT_SPECIFIED: Default value. ,
LOW_PRIVILEGE: Data is not sensitive and ok to access. ,
DEFERRED_ACCESS_CHECK: Used for RP's using a custom authorization check outside of ARM. ,
RP_CONTRACT: RP contract allows certain operations to be unauthorized action. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
authorizationActionMappings:
{
Description: The authorization action mappings. ,
Required: False ,
}
[
{
original:
{
Description: The original action name. ,
Required: False ,
}
string ,
desired:
{
Description: The desired action name. ,
Required: False ,
}
string ,
}
,
]
,
linkedAccessChecks:
{
Description: The linked access checks. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: False ,
}
string ,
linkedProperty:
{
Description: The linked property. ,
Required: False ,
}
string ,
linkedAction:
{
Description: The linked action. ,
Required: False ,
}
string ,
linkedActionVerb:
{
Description: The linked action verb. ,
Required: False ,
}
string ,
linkedType:
{
Description: The linked type. ,
Required: False ,
}
string ,
}
,
]
,
defaultApiVersion:
{
Description: The default api version. ,
Required: False ,
}
string ,
loggingRules:
{
Description: The logging rules. ,
Required: False ,
}
[
{
action:
{
Description: The action. ,
Required: True ,
}
string ,
direction:
{
Description: The direction. ,
Enum:
{
None: No description available. ,
Request: No description available. ,
Response: No description available. ,
}
,
Required: True ,
}
enum ,
detailLevel:
{
Description: The detail level. ,
Enum:
{
None: No description available. ,
Body: No description available. ,
}
,
Required: True ,
}
enum ,
hiddenPropertyPaths:
{
Description: The hidden property paths. ,
Required: False ,
}
string ,
}
,
]
,
throttlingRules:
{
Description: The throttling rules. ,
Required: False ,
}
[
{
action:
{
Description: The action. ,
Required: True ,
}
string ,
metrics:
{
Description: The metrics. ,
Required: True ,
}
[
{
type:
{
Description: The throttling metric type ,
Enum:
{
NotSpecified: No description available. ,
NumberOfRequests: No description available. ,
NumberOfResources: No description available. ,
}
,
Required: True ,
}
enum ,
limit:
{
Description: The limit. ,
Format: int64 ,
Required: True ,
}
integer ,
interval:
{
Description: The interval. ,
Format: duration ,
Required: False ,
}
string ,
}
,
]
,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
applicationId:
{
Description: The application id. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
endpoints:
{
Description: The endpoints. ,
Required: False ,
}
[
{
enabled:
{
Description: Whether the endpoint is enabled. ,
Required: False ,
}
boolean ,
apiVersions:
{
Description: The api versions. ,
Required: False ,
}
[
string ,
]
,
endpointUri:
{
Description: The endpoint uri. ,
Required: False ,
}
string ,
locations:
{
Description: The locations. ,
Required: False ,
}
[
string ,
]
,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
featuresRule:
{
Description: The feature rules. ,
Required: False ,
}
string ,
timeout:
{
Description: The timeout. ,
Format: duration ,
Required: False ,
}
string ,
endpointType:
{
Description: The endpoint type. ,
Enum:
{
NotSpecified: No description available. ,
Canary: No description available. ,
Production: No description available. ,
TestInProduction: No description available. ,
}
,
Required: False ,
}
enum ,
skuLink:
{
Description: The sku link. ,
Required: False ,
}
string ,
}
,
]
,
marketplaceType:
{
Description: The marketplace type. ,
Enum:
{
NotSpecified: No description available. ,
AddOn: No description available. ,
Bypass: No description available. ,
Store: No description available. ,
}
,
Required: False ,
}
enum ,
identityManagement:
{
Description: The identity management. ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
featuresRule:
{
Description: The features rule. ,
Required: False ,
}
string ,
subscriptionStateRules:
{
Description: The subscription state rules. ,
Required: False ,
}
[
{
state:
{
Description: The subscription state. ,
Enum:
{
NotDefined: No description available. ,
Enabled: No description available. ,
Warned: No description available. ,
PastDue: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
allowedActions:
{
Description: The allowed actions. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
serviceTreeInfos:
{
Description: The service tree infos. ,
Required: False ,
}
[
{
serviceId:
{
Description: The service id. ,
Required: False ,
}
string ,
componentId:
{
Description: The component id. ,
Required: False ,
}
string ,
readiness:
{
Description: The readiness. ,
Enum:
{
ClosingDown: No description available. ,
Deprecated: No description available. ,
GA: No description available. ,
InDevelopment: No description available. ,
InternalOnly: No description available. ,
PrivatePreview: No description available. ,
PublicPreview: No description available. ,
RemovedFromARM: No description available. ,
Retired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
requestHeaderOptions:
{
Description: The request header options. ,
Required: False ,
}
string ,
skuLink:
{
Description: The sku link. ,
Required: False ,
}
string ,
disallowedActionVerbs:
{
Description: The disallowed action verbs. ,
Required: False ,
}
[
string ,
]
,
templateDeploymentPolicy:
{
Description: The template deployment policy. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations. ,
Required: False ,
}
[
{
type:
{
Description: The type. ,
Enum:
{
NotSpecified: The extended location type is not specified. ,
CustomLocation: The extended location type is custom location. ,
EdgeZone: The extended location type is edge zone. ,
ArcZone: The extended location type is arc zone. ,
}
,
Required: False ,
}
enum ,
supportedPolicy:
{
Enum:
{
NotSpecified: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
linkedOperationRules:
{
Description: The linked operation rules. ,
Required: False ,
}
[
{
linkedOperation:
{
Description: The linked operation. ,
Enum:
{
None: No description available. ,
CrossResourceGroupResourceMove: No description available. ,
CrossSubscriptionResourceMove: No description available. ,
}
,
Required: True ,
}
enum ,
linkedAction:
{
Description: The linked action. ,
Enum:
{
NotSpecified: No description available. ,
Blocked: No description available. ,
Validate: No description available. ,
Enabled: No description available. ,
}
,
Required: True ,
}
enum ,
dependsOnTypes:
{
Description: Depends on types. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
resourceDeletionPolicy:
{
Description: The resource deletion policy. ,
Enum:
{
NotSpecified: No description available. ,
Cascade: No description available. ,
Force: No description available. ,
}
,
Required: False ,
}
enum ,
quotaRule:
{
Description: The quota rule. ,
Required: False ,
}
{
quotaPolicy:
{
Description: The quota policy. ,
Enum:
{
Default: No description available. ,
None: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
locationRules:
{
Description: The location rules. ,
Required: False ,
}
[
{
policy:
{
Description: The policy. ,
Enum:
{
Default: No description available. ,
None: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
quotaId:
{
Description: The quota id. ,
Required: False ,
}
string ,
location:
{
Description: The location. ,
Required: False ,
}
string ,
}
,
]
,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
}
,
notifications:
{
Description: The notifications. ,
Required: False ,
}
[
{
notificationType:
{
Description: The notification type. ,
Enum:
{
Unspecified: No description available. ,
SubscriptionNotification: No description available. ,
}
,
Required: False ,
}
enum ,
skipNotifications:
{
Description: Whether notifications should be skipped. ,
Enum:
{
Unspecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
linkedNotificationRules:
{
Description: The linked notification rules. ,
Required: False ,
}
[
{
actions:
{
Description: The actions. ,
Required: False ,
}
[
string ,
]
,
actionsOnFailedOperation:
{
Description: The actions on failed operation. ,
Required: False ,
}
[
string ,
]
,
fastPathActions:
{
Description: The fast path actions. ,
Required: False ,
}
[
string ,
]
,
fastPathActionsOnFailedOperation:
{
Description: The fast path action on failed operation. ,
Required: False ,
}
[
string ,
]
,
linkedNotificationTimeout:
{
Description: This is a TimeSpan property. ,
Format: duration ,
Required: False ,
}
string ,
}
,
]
,
resourceProviderAuthorizationRules:
{
Description: The resource provider authorization rules. ,
Required: False ,
}
{
asyncOperationPollingRules:
{
Description: The async operation polling rules. ,
Required: False ,
}
{
authorizationActions:
{
Description: The authorization actions. ,
Required: False ,
}
[
string ,
]
,
additionalOptions:
{
Description: The additional options. ,
Enum:
{
ProtectedAsyncOperationPolling: No description available. ,
ProtectedAsyncOperationPollingAuditOnly: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
management:
{
Description: The resource provider management. ,
Required: False ,
}
string ,
capabilities:
{
Description: The capabilities. ,
Required: False ,
}
[
{
quotaId:
{
Description: The quota id. ,
Required: True ,
}
string ,
effect:
{
Description: The effect. ,
Enum:
{
NotSpecified: No description available. ,
Allow: No description available. ,
Disallow: No description available. ,
}
,
Required: True ,
}
enum ,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
crossTenantTokenValidation:
{
Description: The cross tenant token validation. ,
Enum:
{
EnsureSecureValidation: No description available. ,
PassthroughInsecureToken: No description available. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
globalNotificationEndpoints:
{
Description: The global notification endpoints. ,
Required: False ,
}
[
{
enabled:
{
Description: Whether the endpoint is enabled. ,
Required: False ,
}
boolean ,
apiVersions:
{
Description: The api versions. ,
Required: False ,
}
[
string ,
]
,
endpointUri:
{
Description: The endpoint uri. ,
Required: False ,
}
string ,
locations:
{
Description: The locations. ,
Required: False ,
}
[
string ,
]
,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
featuresRule:
{
Description: The feature rules. ,
Required: False ,
}
string ,
timeout:
{
Description: The timeout. ,
Format: duration ,
Required: False ,
}
string ,
endpointType:
{
Description: The endpoint type. ,
Enum:
{
NotSpecified: No description available. ,
Canary: No description available. ,
Production: No description available. ,
TestInProduction: No description available. ,
}
,
Required: False ,
}
enum ,
skuLink:
{
Description: The sku link. ,
Required: False ,
}
string ,
}
,
]
,
reRegisterSubscriptionMetadata:
{
Description: The re-register subscription metadata. ,
Required: False ,
}
string ,
enableTenantLinkedNotification:
{
Description: Whether tenant linked notification is enabled. ,
Required: False ,
}
boolean ,
notifications:
{
Description: The notifications. ,
Required: False ,
}
[
{
notificationType:
{
Description: The notification type. ,
Enum:
{
Unspecified: No description available. ,
SubscriptionNotification: No description available. ,
}
,
Required: False ,
}
enum ,
skipNotifications:
{
Description: Whether notifications should be skipped. ,
Enum:
{
Unspecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
linkedNotificationRules:
{
Description: The linked notification rules. ,
Required: False ,
}
[
{
tokenAuthConfiguration:
{
Description: The token auth configuration. ,
Required: False ,
}
{
authenticationScheme:
{
Description: The authentication scheme. ,
Enum:
{
PoP: No description available. ,
Bearer: No description available. ,
}
,
Required: False ,
}
enum ,
signedRequestScope:
{
Description: The signed request scope. ,
Enum:
{
ResourceUri: No description available. ,
Endpoint: No description available. ,
}
,
Required: False ,
}
enum ,
disableCertificateAuthenticationFallback:
{
Description: Whether certification authentication fallback is disabled. ,
Required: False ,
}
boolean ,
}
,
actions:
{
Description: The actions. ,
Required: False ,
}
[
string ,
]
,
endpoints:
{
Description: The endpoints. ,
Required: False ,
}
[
{
enabled:
{
Description: Whether the endpoint is enabled. ,
Required: False ,
}
boolean ,
apiVersions:
{
Description: The api versions. ,
Required: False ,
}
[
string ,
]
,
endpointUri:
{
Description: The endpoint uri. ,
Required: False ,
}
string ,
locations:
{
Description: The locations. ,
Required: False ,
}
[
string ,
]
,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
featuresRule:
{
Description: The feature rules. ,
Required: False ,
}
string ,
timeout:
{
Description: The timeout. ,
Format: duration ,
Required: False ,
}
string ,
endpointType:
{
Description: The endpoint type. ,
Enum:
{
NotSpecified: No description available. ,
Canary: No description available. ,
Production: No description available. ,
TestInProduction: No description available. ,
}
,
Required: False ,
}
enum ,
skuLink:
{
Description: The sku link. ,
Required: False ,
}
string ,
}
,
]
,
dstsConfiguration:
{
Description: The dsts configuration. ,
Required: False ,
}
string ,
}
,
]
,
resourceProviderAuthorizationRules:
{
Description: The resource provider authorization rules. ,
Required: False ,
}
{
asyncOperationPollingRules:
{
Description: The async operation polling rules. ,
Required: False ,
}
{
authorizationActions:
{
Description: The authorization actions. ,
Required: False ,
}
[
string ,
]
,
additionalOptions:
{
Description: The additional options. ,
Enum:
{
ProtectedAsyncOperationPolling: No description available. ,
ProtectedAsyncOperationPollingAuditOnly: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
CheckinManifest (new)
Description :  Checkin the manifest.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/checkinManifest
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
checkinManifestParams:
{
Description: The required body parameters supplied to the checkin manifest operation. ,
Required: True ,
}
{
environment:
{
Description: The environment supplied to the checkin manifest operation. ,
Required: True ,
}
string ,
baselineArmManifestLocation:
{
Description: The baseline ARM manifest location supplied to the checkin manifest operation. ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
isCheckedIn:
{
Description: Whether the manifest is checked in. ,
Required: True ,
}
boolean ,
statusMessage:
{
Description: The status message. ,
Required: True ,
}
string ,
pullRequest:
{
Description: The pull request. ,
Required: False ,
}
string ,
commitId:
{
Description: The commit id. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationRegistrations_Get (new)
Description :  Gets the notification registration details.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/notificationRegistrations/{notificationRegistrationName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
notificationRegistrationName:
{
Description: The notification registration. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
notificationMode:
{
Description: The notification mode. ,
Enum:
{
NotSpecified: No description available. ,
EventHub: No description available. ,
WebHook: No description available. ,
}
,
Required: False ,
}
enum ,
messageScope:
{
Description: The message scope. ,
Enum:
{
NotSpecified: No description available. ,
RegisteredSubscriptions: No description available. ,
}
,
Required: False ,
}
enum ,
includedEvents:
{
Description: The included events. ,
Required: False ,
}
[
string ,
]
,
notificationEndpoints:
{
Description: The notification endpoints. ,
Required: False ,
}
[
{
notificationDestination:
{
Description: The notification destination. ,
Required: False ,
}
string ,
locations:
{
Description: The locations. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationRegistrations_CreateOrUpdate (new)
Description :  Creates or updates a notification registration.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/notificationRegistrations/{notificationRegistrationName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
notificationRegistrationName:
{
Description: The notification registration. ,
Required: True ,
}
string ,
properties:
{
Description: The required body parameters supplied to the notification registration operation. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
notificationMode:
{
Description: The notification mode. ,
Enum:
{
NotSpecified: No description available. ,
EventHub: No description available. ,
WebHook: No description available. ,
}
,
Required: False ,
}
enum ,
messageScope:
{
Description: The message scope. ,
Enum:
{
NotSpecified: No description available. ,
RegisteredSubscriptions: No description available. ,
}
,
Required: False ,
}
enum ,
includedEvents:
{
Description: The included events. ,
Required: False ,
}
[
string ,
]
,
notificationEndpoints:
{
Description: The notification endpoints. ,
Required: False ,
}
[
{
notificationDestination:
{
Description: The notification destination. ,
Required: False ,
}
string ,
locations:
{
Description: The locations. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
notificationMode:
{
Description: The notification mode. ,
Enum:
{
NotSpecified: No description available. ,
EventHub: No description available. ,
WebHook: No description available. ,
}
,
Required: False ,
}
enum ,
messageScope:
{
Description: The message scope. ,
Enum:
{
NotSpecified: No description available. ,
RegisteredSubscriptions: No description available. ,
}
,
Required: False ,
}
enum ,
includedEvents:
{
Description: The included events. ,
Required: False ,
}
[
string ,
]
,
notificationEndpoints:
{
Description: The notification endpoints. ,
Required: False ,
}
[
{
notificationDestination:
{
Description: The notification destination. ,
Required: False ,
}
string ,
locations:
{
Description: The locations. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationRegistrations_Delete (new)
Description :  Deletes a notification registration.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/notificationRegistrations/{notificationRegistrationName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
notificationRegistrationName:
{
Description: The notification registration. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NotificationRegistrations_ListByProviderRegistration (new)
Description :  Gets the list of the notification registrations for the given provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/notificationRegistrations
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
notificationMode:
{
Description: The notification mode. ,
Enum:
{
NotSpecified: No description available. ,
EventHub: No description available. ,
WebHook: No description available. ,
}
,
Required: False ,
}
enum ,
messageScope:
{
Description: The message scope. ,
Enum:
{
NotSpecified: No description available. ,
RegisteredSubscriptions: No description available. ,
}
,
Required: False ,
}
enum ,
includedEvents:
{
Description: The included events. ,
Required: False ,
}
[
string ,
]
,
notificationEndpoints:
{
Description: The notification endpoints. ,
Required: False ,
}
[
{
notificationDestination:
{
Description: The notification destination. ,
Required: False ,
}
string ,
locations:
{
Description: The locations. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get to the next set of results, if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_List (new)
Description :  Lists all the operations supported by Microsoft.ProviderHub.
Reference :  Link ¶

⚼ Request

GET:  /providers/Microsoft.ProviderHub/operations
{}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: False ,
}
[
{
name:
{
Description: Name of the operation. ,
Required: True ,
}
string ,
isDataAction:
{
Description: Indicates whether the operation applies to data-plane. ,
Required: False ,
}
boolean ,
origin:
{
Description: The origin. ,
Enum:
{
NotSpecified: No description available. ,
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
display:
{
Description: Display information of the operation. ,
Required: True ,
}
string ,
actionType:
{
Description: The action type. ,
Enum:
{
NotSpecified: No description available. ,
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: The URL to get to the next set of results, if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_ListByProviderRegistration (new)
Description :  Gets the operations supported by the given provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/operations/default
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name of the operation. ,
Required: True ,
}
string ,
isDataAction:
{
Description: Indicates whether the operation applies to data-plane. ,
Required: False ,
}
boolean ,
origin:
{
Description: The origin. ,
Enum:
{
NotSpecified: No description available. ,
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
display:
{
Description: Display information of the operation. ,
Required: True ,
}
string ,
actionType:
{
Description: The action type. ,
Enum:
{
NotSpecified: No description available. ,
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_CreateOrUpdate (new)
Description :  Creates or updates the operation supported by the given provider.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/operations/default
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
OperationsPutContent:
{
Description: The operations content properties supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
object ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
object ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Operations_Delete (new)
Description :  Deletes an operation.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/operations/default
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProviderRegistrations_Get (new)
Description :  Gets the provider registration details.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
providerHubMetadata:
{
Description: The provider hub metadata. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionLifecycleNotificationSpecifications:
{
Description: The subscription lifecycle notification specifications. ,
Required: False ,
}
string ,
privateResourceProviderConfiguration:
{
Description: The private resource provider configuration. ,
Required: False ,
}
string ,
tokenAuthConfiguration:
{
Description: The token auth configuration. ,
Required: False ,
}
{
authenticationScheme:
{
Description: The authentication scheme. ,
Enum:
{
PoP: No description available. ,
Bearer: No description available. ,
}
,
Required: False ,
}
enum ,
signedRequestScope:
{
Description: The signed request scope. ,
Enum:
{
ResourceUri: No description available. ,
Endpoint: No description available. ,
}
,
Required: False ,
}
enum ,
disableCertificateAuthenticationFallback:
{
Description: Whether certification authentication fallback is disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
kind:
{
Description: Provider registration kind. This Metadata is also used by portal/tooling/etc to render different UX experiences for resources of the same type. ,
Enum:
{
Managed: Resource Provider with all the resource types 'managed' by the ProviderHub service. ,
Hybrid: Resource Provider with a mix of 'managed' and 'direct' resource types. ,
Direct: Resource Provider with all the resource types 'managed' on by itself. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProviderRegistrations_CreateOrUpdate (new)
Description :  Creates or updates the provider registration.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
properties:
{
Description: The provider registration properties supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
providerHubMetadata:
{
Description: The provider hub metadata. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionLifecycleNotificationSpecifications:
{
Description: The subscription lifecycle notification specifications. ,
Required: False ,
}
string ,
privateResourceProviderConfiguration:
{
Description: The private resource provider configuration. ,
Required: False ,
}
string ,
tokenAuthConfiguration:
{
Description: The token auth configuration. ,
Required: False ,
}
{
authenticationScheme:
{
Description: The authentication scheme. ,
Enum:
{
PoP: No description available. ,
Bearer: No description available. ,
}
,
Required: False ,
}
enum ,
signedRequestScope:
{
Description: The signed request scope. ,
Enum:
{
ResourceUri: No description available. ,
Endpoint: No description available. ,
}
,
Required: False ,
}
enum ,
disableCertificateAuthenticationFallback:
{
Description: Whether certification authentication fallback is disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
kind:
{
Description: Provider registration kind. This Metadata is also used by portal/tooling/etc to render different UX experiences for resources of the same type. ,
Enum:
{
Managed: Resource Provider with all the resource types 'managed' by the ProviderHub service. ,
Hybrid: Resource Provider with a mix of 'managed' and 'direct' resource types. ,
Direct: Resource Provider with all the resource types 'managed' on by itself. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
providerHubMetadata:
{
Description: The provider hub metadata. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionLifecycleNotificationSpecifications:
{
Description: The subscription lifecycle notification specifications. ,
Required: False ,
}
string ,
privateResourceProviderConfiguration:
{
Description: The private resource provider configuration. ,
Required: False ,
}
string ,
tokenAuthConfiguration:
{
Description: The token auth configuration. ,
Required: False ,
}
{
authenticationScheme:
{
Description: The authentication scheme. ,
Enum:
{
PoP: No description available. ,
Bearer: No description available. ,
}
,
Required: False ,
}
enum ,
signedRequestScope:
{
Description: The signed request scope. ,
Enum:
{
ResourceUri: No description available. ,
Endpoint: No description available. ,
}
,
Required: False ,
}
enum ,
disableCertificateAuthenticationFallback:
{
Description: Whether certification authentication fallback is disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
kind:
{
Description: Provider registration kind. This Metadata is also used by portal/tooling/etc to render different UX experiences for resources of the same type. ,
Enum:
{
Managed: Resource Provider with all the resource types 'managed' by the ProviderHub service. ,
Hybrid: Resource Provider with a mix of 'managed' and 'direct' resource types. ,
Direct: Resource Provider with all the resource types 'managed' on by itself. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (201)

{
properties:
{
Required: False ,
}
{
providerHubMetadata:
{
Description: The provider hub metadata. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionLifecycleNotificationSpecifications:
{
Description: The subscription lifecycle notification specifications. ,
Required: False ,
}
string ,
privateResourceProviderConfiguration:
{
Description: The private resource provider configuration. ,
Required: False ,
}
string ,
tokenAuthConfiguration:
{
Description: The token auth configuration. ,
Required: False ,
}
{
authenticationScheme:
{
Description: The authentication scheme. ,
Enum:
{
PoP: No description available. ,
Bearer: No description available. ,
}
,
Required: False ,
}
enum ,
signedRequestScope:
{
Description: The signed request scope. ,
Enum:
{
ResourceUri: No description available. ,
Endpoint: No description available. ,
}
,
Required: False ,
}
enum ,
disableCertificateAuthenticationFallback:
{
Description: Whether certification authentication fallback is disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
kind:
{
Description: Provider registration kind. This Metadata is also used by portal/tooling/etc to render different UX experiences for resources of the same type. ,
Enum:
{
Managed: Resource Provider with all the resource types 'managed' by the ProviderHub service. ,
Hybrid: Resource Provider with a mix of 'managed' and 'direct' resource types. ,
Direct: Resource Provider with all the resource types 'managed' on by itself. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProviderRegistrations_Delete (new)
Description :  Deletes a provider registration.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProviderRegistrations_List (new)
Description :  Gets the list of the provider registrations in the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
providerHubMetadata:
{
Description: The provider hub metadata. ,
Required: False ,
}
string ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
subscriptionLifecycleNotificationSpecifications:
{
Description: The subscription lifecycle notification specifications. ,
Required: False ,
}
string ,
privateResourceProviderConfiguration:
{
Description: The private resource provider configuration. ,
Required: False ,
}
string ,
tokenAuthConfiguration:
{
Description: The token auth configuration. ,
Required: False ,
}
{
authenticationScheme:
{
Description: The authentication scheme. ,
Enum:
{
PoP: No description available. ,
Bearer: No description available. ,
}
,
Required: False ,
}
enum ,
signedRequestScope:
{
Description: The signed request scope. ,
Enum:
{
ResourceUri: No description available. ,
Endpoint: No description available. ,
}
,
Required: False ,
}
enum ,
disableCertificateAuthenticationFallback:
{
Description: Whether certification authentication fallback is disabled. ,
Required: False ,
}
boolean ,
}
,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
kind:
{
Description: Provider registration kind. This Metadata is also used by portal/tooling/etc to render different UX experiences for resources of the same type. ,
Enum:
{
Managed: Resource Provider with all the resource types 'managed' by the ProviderHub service. ,
Hybrid: Resource Provider with a mix of 'managed' and 'direct' resource types. ,
Direct: Resource Provider with all the resource types 'managed' on by itself. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The URL to get to the next set of results, if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProviderRegistrations_GenerateOperations (new)
Description :  Generates the operations api for the given provider.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/generateOperations
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Name of the operation. ,
Required: True ,
}
string ,
isDataAction:
{
Description: Indicates whether the operation applies to data-plane. ,
Required: False ,
}
boolean ,
origin:
{
Description: The origin. ,
Enum:
{
NotSpecified: No description available. ,
User: No description available. ,
System: No description available. ,
}
,
Required: False ,
}
enum ,
display:
{
Description: Display information of the operation. ,
Required: True ,
}
string ,
actionType:
{
Description: The action type. ,
Enum:
{
NotSpecified: No description available. ,
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
properties:
{
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ResourceTypeRegistrations_Get (new)
Description :  Gets a resource type details in the given subscription and provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourcetypeRegistrations/{resourceType}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
routingType:
{
Description: The resource routing type. ,
Enum:
{
Default: The resource routing type is default. ,
ProxyOnly: The resource routing type is proxy only. ,
HostBased: The resource routing type is host based. ,
Extension: The resource routing type is extension. ,
Tenant: The resource routing type is tenant. ,
Fanout: The resource routing type is fanout. ,
LocationBased: The resource routing type is location based. ,
Failover: The resource routing type is failover. ,
CascadeExtension: The resource routing type is cascade extension. ,
ChildFanout: The resource routing type is child fanout. ,
CascadeAuthorizedExtension: The resource routing type is cascade authorized extension. ,
BypassEndpointSelectionOptimization: The resource routing type is bypass endpoint selection optimization. ,
LocationMapping: The resource routing type is location mapping. ,
ServiceFanout: The resource routing type is service fanout. ,
}
,
Required: False ,
}
enum ,
additionalOptions:
{
Description: The additional options. ,
Enum:
{
ProtectedAsyncOperationPolling: No description available. ,
ProtectedAsyncOperationPollingAuditOnly: No description available. ,
}
,
Required: False ,
}
enum ,
crossTenantTokenValidation:
{
Description: The cross tenant token validation. ,
Enum:
{
EnsureSecureValidation: No description available. ,
PassthroughInsecureToken: No description available. ,
}
,
Required: False ,
}
enum ,
regionality:
{
Description: The regionality. ,
Enum:
{
NotSpecified: No description available. ,
Global: No description available. ,
Regional: No description available. ,
}
,
Required: False ,
}
enum ,
endpoints:
{
Description: The extensions. ,
Required: False ,
}
[
{
kind:
{
Description: Resource type endpoint kind. This Metadata is also used by portal/tooling/etc to render different UX experiences for resources of the same type. ,
Enum:
{
Managed: Endpoint served by ProviderHub service ,
Direct: Endpoint served by the onboarded Resource Provider Service. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: Whether the endpoint is enabled. ,
Required: False ,
}
boolean ,
apiVersions:
{
Description: The api versions. ,
Required: False ,
}
[
string ,
]
,
locations:
{
Description: The locations. ,
Required: False ,
}
[
string ,
]
,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
featuresRule:
{
Description: The features rule. ,
Required: False ,
}
string ,
extensions:
{
Description: The extensions. ,
Required: False ,
}
[
{
endpointUri:
{
Description: The endpoint uri. ,
Required: False ,
}
string ,
extensionCategories:
{
Description: The extension categories. ,
Required: False ,
}
[
string ,
]
,
timeout:
{
Description: The timeout. ,
Format: duration ,
Required: False ,
}
string ,
}
,
]
,
timeout:
{
Description: The timeout. ,
Format: duration ,
Required: False ,
}
string ,
endpointType:
{
Description: The endpoint type. ,
Enum:
{
NotSpecified: No description available. ,
Canary: No description available. ,
Production: No description available. ,
TestInProduction: No description available. ,
}
,
Required: False ,
}
enum ,
tokenAuthConfiguration:
{
Description: The token auth configuration. ,
Required: False ,
}
{
authenticationScheme:
{
Description: The authentication scheme. ,
Enum:
{
PoP: No description available. ,
Bearer: No description available. ,
}
,
Required: False ,
}
enum ,
signedRequestScope:
{
Description: The signed request scope. ,
Enum:
{
ResourceUri: No description available. ,
Endpoint: No description available. ,
}
,
Required: False ,
}
enum ,
disableCertificateAuthenticationFallback:
{
Description: Whether certification authentication fallback is disabled. ,
Required: False ,
}
boolean ,
}
,
skuLink:
{
Description: The sku link. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The endpoint uri. ,
Required: False ,
}
string ,
apiVersion:
{
Description: Api version. ,
Required: False ,
}
string ,
zones:
{
Description: List of zones. ,
Required: False ,
}
[
string ,
]
,
dstsConfiguration:
{
Description: The dsts configuration. ,
Required: False ,
}
string ,
dataBoundary:
{
Description: The data boundary. ,
Enum:
{
NotDefined: No description available. ,
Global: No description available. ,
EU: No description available. ,
US: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
extensionOptions:
{
Description: The extension options. ,
Required: False ,
}
string ,
marketplaceType:
{
Description: The marketplace type. ,
Enum:
{
NotSpecified: No description available. ,
AddOn: No description available. ,
Bypass: No description available. ,
Store: No description available. ,
}
,
Required: False ,
}
enum ,
swaggerSpecifications:
{
Description: The swagger specifications. ,
Required: False ,
}
[
{
apiVersions:
{
Description: The api versions. ,
Required: False ,
}
[
string ,
]
,
swaggerSpecFolderUri:
{
Description: The swagger spec folder uri. ,
Required: False ,
}
string ,
}
,
]
,
allowedUnauthorizedActions:
{
Description: The allowed unauthorized actions. ,
Required: False ,
}
[
string ,
]
,
allowedUnauthorizedActionsExtensions:
{
Description: The allowed unauthorized actions extensions. ,
Required: False ,
}
[
{
action:
{
Description: The action. ,
Required: False ,
}
string ,
intent:
{
Description: The intent. ,
Enum:
{
NOT_SPECIFIED: Default value. ,
LOW_PRIVILEGE: Data is not sensitive and ok to access. ,
DEFERRED_ACCESS_CHECK: Used for RP's using a custom authorization check outside of ARM. ,
RP_CONTRACT: RP contract allows certain operations to be unauthorized action. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
authorizationActionMappings:
{
Description: The authorization action mappings ,
Required: False ,
}
[
{
original:
{
Description: The original action name. ,
Required: False ,
}
string ,
desired:
{
Description: The desired action name. ,
Required: False ,
}
string ,
}
,
]
,
linkedAccessChecks:
{
Description: The linked access checks. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: False ,
}
string ,
linkedProperty:
{
Description: The linked property. ,
Required: False ,
}
string ,
linkedAction:
{
Description: The linked action. ,
Required: False ,
}
string ,
linkedActionVerb:
{
Description: The linked action verb. ,
Required: False ,
}
string ,
linkedType:
{
Description: The linked type. ,
Required: False ,
}
string ,
}
,
]
,
defaultApiVersion:
{
Description: The default api version. ,
Required: False ,
}
string ,
loggingRules:
{
Description: The logging rules. ,
Required: False ,
}
[
{
action:
{
Description: The action. ,
Required: True ,
}
string ,
direction:
{
Description: The direction. ,
Enum:
{
None: No description available. ,
Request: No description available. ,
Response: No description available. ,
}
,
Required: True ,
}
enum ,
detailLevel:
{
Description: The detail level. ,
Enum:
{
None: No description available. ,
Body: No description available. ,
}
,
Required: True ,
}
enum ,
hiddenPropertyPaths:
{
Description: The hidden property paths. ,
Required: False ,
}
string ,
}
,
]
,
throttlingRules:
{
Description: The throttling rules. ,
Required: False ,
}
[
{
action:
{
Description: The action. ,
Required: True ,
}
string ,
metrics:
{
Description: The metrics. ,
Required: True ,
}
[
{
type:
{
Description: The throttling metric type ,
Enum:
{
NotSpecified: No description available. ,
NumberOfRequests: No description available. ,
NumberOfResources: No description available. ,
}
,
Required: True ,
}
enum ,
limit:
{
Description: The limit. ,
Format: int64 ,
Required: True ,
}
integer ,
interval:
{
Description: The interval. ,
Format: duration ,
Required: False ,
}
string ,
}
,
]
,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
applicationId:
{
Description: The application id. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
featuresRule:
{
Description: The features rule. ,
Required: False ,
}
string ,
enableAsyncOperation:
{
Description: Whether async operation is enabled. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
enableThirdPartyS2S:
{
Description: Whether third party S2S is enabled. ,
Required: False ,
}
boolean ,
subscriptionLifecycleNotificationSpecifications:
{
Description: The subscription lifecycle notification specifications. ,
Required: False ,
}
string ,
isPureProxy:
{
Description: Whether it is pure proxy. ,
Required: False ,
}
boolean ,
identityManagement:
{
Description: The identity management. ,
Required: False ,
}
string ,
checkNameAvailabilitySpecifications:
{
Description: The check name availability specifications. ,
Required: False ,
}
string ,
disallowedActionVerbs:
{
Description: The disallowed action verbs. ,
Required: False ,
}
[
string ,
]
,
serviceTreeInfos:
{
Description: The service tree infos. ,
Required: False ,
}
[
{
serviceId:
{
Description: The service id. ,
Required: False ,
}
string ,
componentId:
{
Description: The component id. ,
Required: False ,
}
string ,
readiness:
{
Description: The readiness. ,
Enum:
{
ClosingDown: No description available. ,
Deprecated: No description available. ,
GA: No description available. ,
InDevelopment: No description available. ,
InternalOnly: No description available. ,
PrivatePreview: No description available. ,
PublicPreview: No description available. ,
RemovedFromARM: No description available. ,
Retired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
requestHeaderOptions:
{
Description: The request header options. ,
Required: False ,
}
string ,
subscriptionStateRules:
{
Description: The subscription state rules. ,
Required: False ,
}
[
{
state:
{
Description: The subscription state. ,
Enum:
{
NotDefined: No description available. ,
Enabled: No description available. ,
Warned: No description available. ,
PastDue: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
allowedActions:
{
Description: The allowed actions. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
templateDeploymentOptions:
{
Description: The template deployment options. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations. ,
Required: False ,
}
[
{
type:
{
Description: The type. ,
Enum:
{
NotSpecified: The extended location type is not specified. ,
CustomLocation: The extended location type is custom location. ,
EdgeZone: The extended location type is edge zone. ,
ArcZone: The extended location type is arc zone. ,
}
,
Required: False ,
}
enum ,
supportedPolicy:
{
Enum:
{
NotSpecified: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resourceMovePolicy:
{
Description: The resource move policy. ,
Required: False ,
}
string ,
resourceDeletionPolicy:
{
Description: The resource deletion policy. ,
Enum:
{
NotSpecified: No description available. ,
CascadeDeleteAll: No description available. ,
CascadeDeleteProxyOnlyChildren: No description available. ,
}
,
Required: False ,
}
enum ,
resourceConcurrencyControlOptions:
{
Description: The resource concurrency control options. ,
Required: False ,
}
object ,
resourceGraphConfiguration:
{
Description: The resource graph configuration. ,
Required: False ,
}
string ,
management:
{
Description: The resource provider management. ,
Required: False ,
}
string ,
openApiConfiguration:
{
Description: The open api configuration. ,
Required: False ,
}
{
validation:
{
Description: The open api validation. ,
Required: False ,
}
{
allowNoncompliantCollectionResponse:
{
Description: Indicates whether a non compliance response is allowed for a LIST call ,
Required: False ,
}
boolean ,
}
,
}
,
onBehalfOfTokens:
{
Description: The on behalf of tokens. ,
Required: False ,
}
{
actionName:
{
Description: The action name. ,
Required: False ,
}
string ,
lifeTime:
{
Description: This is a TimeSpan property. ,
Required: False ,
}
string ,
}
,
category:
{
Description: The category. ,
Enum:
{
None: No description available. ,
FreeForm: No description available. ,
Internal: No description available. ,
PureProxy: No description available. ,
}
,
Required: False ,
}
enum ,
resourceValidation:
{
Description: The resource validation. ,
Enum:
{
NotSpecified: No description available. ,
ReservedWords: No description available. ,
ProfaneWords: No description available. ,
}
,
Required: False ,
}
enum ,
disallowedEndUserOperations:
{
Description: The disallowed end user operations. ,
Required: False ,
}
[
string ,
]
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
skuLink:
{
Description: The sku link. ,
Required: False ,
}
string ,
quotaRule:
{
Description: The quota rule. ,
Required: False ,
}
{
quotaPolicy:
{
Description: The quota policy. ,
Enum:
{
Default: No description available. ,
None: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
locationRules:
{
Description: The location rules. ,
Required: False ,
}
[
{
policy:
{
Description: The policy. ,
Enum:
{
Default: No description available. ,
None: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
quotaId:
{
Description: The quota id. ,
Required: False ,
}
string ,
location:
{
Description: The location. ,
Required: False ,
}
string ,
}
,
]
,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
}
,
notifications:
{
Description: The notifications. ,
Required: False ,
}
[
{
notificationType:
{
Description: The notification type. ,
Enum:
{
Unspecified: No description available. ,
SubscriptionNotification: No description available. ,
}
,
Required: False ,
}
enum ,
skipNotifications:
{
Description: Whether notifications should be skipped. ,
Enum:
{
Unspecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
linkedNotificationRules:
{
Description: The linked notification rules. ,
Required: False ,
}
[
{
actions:
{
Description: The actions. ,
Required: False ,
}
[
string ,
]
,
actionsOnFailedOperation:
{
Description: The actions on failed operation. ,
Required: False ,
}
[
string ,
]
,
fastPathActions:
{
Description: The fast path actions. ,
Required: False ,
}
[
string ,
]
,
fastPathActionsOnFailedOperation:
{
Description: The fast path action on failed operation. ,
Required: False ,
}
[
string ,
]
,
linkedNotificationTimeout:
{
Description: This is a TimeSpan property. ,
Format: duration ,
Required: False ,
}
string ,
}
,
]
,
resourceProviderAuthorizationRules:
{
Description: The resource provider authorization rules. ,
Required: False ,
}
{
asyncOperationPollingRules:
{
Description: The async operation polling rules. ,
Required: False ,
}
{
authorizationActions:
{
Description: The authorization actions. ,
Required: False ,
}
[
string ,
]
,
additionalOptions:
{
Description: The additional options. ,
Enum:
{
ProtectedAsyncOperationPolling: No description available. ,
ProtectedAsyncOperationPollingAuditOnly: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
tokenAuthConfiguration:
{
Description: The token auth configuration. ,
Required: False ,
}
{
authenticationScheme:
{
Description: The authentication scheme. ,
Enum:
{
PoP: No description available. ,
Bearer: No description available. ,
}
,
Required: False ,
}
enum ,
signedRequestScope:
{
Description: The signed request scope. ,
Enum:
{
ResourceUri: No description available. ,
Endpoint: No description available. ,
}
,
Required: False ,
}
enum ,
disableCertificateAuthenticationFallback:
{
Description: Whether certification authentication fallback is disabled. ,
Required: False ,
}
boolean ,
}
,
templateDeploymentPolicy:
{
Description: The template deployment policy. ,
Required: False ,
}
string ,
allowEmptyRoleAssignments:
{
Description: The allow empty role assignments. ,
Required: False ,
}
boolean ,
policyExecutionType:
{
Description: The policy execution type. ,
Enum:
{
NotSpecified: No description available. ,
ExecutePolicies: No description available. ,
BypassPolicies: No description available. ,
ExpectPartialPutRequests: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityZoneRule:
{
Description: The availability zone rule. ,
Required: False ,
}
{
availabilityZonePolicy:
{
Enum:
{
NotSpecified: No description available. ,
SingleZoned: No description available. ,
MultiZoned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dstsConfiguration:
{
Description: The dsts configuration. ,
Required: False ,
}
string ,
asyncTimeoutRules:
{
Description: Async timeout rules ,
Required: False ,
}
[
{
actionName:
{
Required: False ,
}
string ,
timeout:
{
Description: This is a TimeSpan property ,
Required: False ,
}
string ,
}
,
]
,
commonApiVersions:
{
Description: Common API versions for the resource type. ,
Required: False ,
}
[
string ,
]
,
apiProfiles:
{
Description: The api profiles. ,
Required: False ,
}
[
{
profileVersion:
{
Description: Profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: Api version. ,
Required: False ,
}
string ,
}
,
]
,
linkedOperationRules:
{
Description: The linked operation rules. ,
Required: False ,
}
[
{
linkedOperation:
{
Description: The linked operation. ,
Enum:
{
None: No description available. ,
CrossResourceGroupResourceMove: No description available. ,
CrossSubscriptionResourceMove: No description available. ,
}
,
Required: True ,
}
enum ,
linkedAction:
{
Description: The linked action. ,
Enum:
{
NotSpecified: No description available. ,
Blocked: No description available. ,
Validate: No description available. ,
Enabled: No description available. ,
}
,
Required: True ,
}
enum ,
dependsOnTypes:
{
Description: Depends on types. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
legacyName:
{
Description: The legacy name. ,
Required: False ,
}
string ,
legacyNames:
{
Description: The legacy names. ,
Required: False ,
}
[
string ,
]
,
allowedTemplateDeploymentReferenceActions:
{
Description: Allowed template deployment reference actions. ,
Required: False ,
}
[
string ,
]
,
legacyPolicy:
{
Description: The legacy policy. ,
Required: False ,
}
{
disallowedLegacyOperations:
{
Required: False ,
}
[
string ,
]
,
disallowedConditions:
{
Required: False ,
}
[
{
disallowedLegacyOperations:
{
Description: The disallowed legacy operations. ,
Required: False ,
}
[
string ,
]
,
feature:
{
Description: Feature string. ,
Required: False ,
}
string ,
}
,
]
,
}
,
manifestLink:
{
Description: Manifest link. ,
Required: False ,
}
string ,
capacityRule:
{
Description: Capacity rule. ,
Required: False ,
}
{
capacityPolicy:
{
Description: Capacity policy. ,
Enum:
{
Default: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
skuAlias:
{
Description: Sku alias ,
Required: False ,
}
string ,
}
,
marketplaceOptions:
{
Description: Marketplace options. ,
Required: False ,
}
{
addOnPlanConversionAllowed:
{
Description: Add-on plan conversion allowed. ,
Required: False ,
}
boolean ,
}
,
allowedResourceNames:
{
Description: The allowed resource names. ,
Required: False ,
}
[
{
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
getActionVerb:
{
Description: Get action verb. ,
Required: False ,
}
string ,
}
,
]
,
resourceCache:
{
Description: Resource cache options. ,
Required: False ,
}
{
enableResourceCache:
{
Description: Enable resource cache. ,
Required: False ,
}
boolean ,
resourceCacheExpirationTimespan:
{
Description: Resource cache expiration timespan. This is a TimeSpan property. ,
Required: False ,
}
string ,
}
,
resourceQueryManagement:
{
Description: Resource query management options. ,
Required: False ,
}
{
filterOption:
{
Description: Filter option. ,
Enum:
{
NotSpecified: No description available. ,
EnableSubscriptionFilterOnTenant: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
supportsTags:
{
Description: Whether tags are supported. ,
Required: False ,
}
boolean ,
resourceManagementOptions:
{
Description: Resource management options. ,
Required: False ,
}
{
batchProvisioningSupport:
{
Description: Batch provisioning support. ,
Required: False ,
}
{
supportedOperations:
{
Description: Supported operations. ,
Enum:
{
NotSpecified: No description available. ,
Get: No description available. ,
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
deleteDependencies:
{
Description: Delete dependencies. ,
Required: False ,
}
[
{
requiredFeatures:
{
Description: Required features. ,
Required: False ,
}
[
string ,
]
,
linkedProperty:
{
Description: Linked property. ,
Required: False ,
}
string ,
linkedType:
{
Description: Linked type. ,
Required: False ,
}
string ,
}
,
]
,
nestedProvisioningSupport:
{
Description: Nested provisioning support. ,
Required: False ,
}
{
minimumApiVersion:
{
Description: Minimum API version. ,
Required: False ,
}
string ,
}
,
}
,
groupingTag:
{
Description: Grouping tag. ,
Required: False ,
}
string ,
addResourceListTargetLocations:
{
Description: Add resource list target locations? ,
Required: False ,
}
boolean ,
resourceTypeCommonAttributeManagement:
{
Description: Resource type common attribute management. ,
Required: False ,
}
{
commonApiVersionsMergeMode:
{
Description: Common api versions merge mode. ,
Enum:
{
Merge: No description available. ,
Overwrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
routingRule:
{
Description: Routing rule. ,
Required: False ,
}
{
hostResourceType:
{
Description: Hosted resource type. ,
Required: False ,
}
string ,
}
,
frontdoorRequestMode:
{
Description: The frontdoor request mode. ,
Enum:
{
NotSpecified: No description available. ,
UseManifest: No description available. ,
}
,
Required: False ,
}
enum ,
resourceSubType:
{
Description: The resource sub type. ,
Enum:
{
NotSpecified: No description available. ,
AsyncOperation: No description available. ,
}
,
Required: False ,
}
enum ,
asyncOperationResourceTypeName:
{
Description: The async operation resource type name. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
kind:
{
Description: Resource type registration kind. This Metadata is also used by portal/tooling/etc to render different UX experiences for resources of the same type. ,
Enum:
{
Managed: Resource type served by the ProviderHub service. ,
Hybrid: Resource type served by both the ProviderHub & the onboarded Resource Provider Services (i.e. The type has a mix of managed and direct endpoints). ,
Direct: Resource type served by the onboarded Resource Provider Service. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ResourceTypeRegistrations_CreateOrUpdate (new)
Description :  Creates or updates a resource type.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourcetypeRegistrations/{resourceType}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type. ,
Required: True ,
}
string ,
properties:
{
Description: The required request body parameters supplied to the resource type registration CreateOrUpdate operation. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
routingType:
{
Description: The resource routing type. ,
Enum:
{
Default: The resource routing type is default. ,
ProxyOnly: The resource routing type is proxy only. ,
HostBased: The resource routing type is host based. ,
Extension: The resource routing type is extension. ,
Tenant: The resource routing type is tenant. ,
Fanout: The resource routing type is fanout. ,
LocationBased: The resource routing type is location based. ,
Failover: The resource routing type is failover. ,
CascadeExtension: The resource routing type is cascade extension. ,
ChildFanout: The resource routing type is child fanout. ,
CascadeAuthorizedExtension: The resource routing type is cascade authorized extension. ,
BypassEndpointSelectionOptimization: The resource routing type is bypass endpoint selection optimization. ,
LocationMapping: The resource routing type is location mapping. ,
ServiceFanout: The resource routing type is service fanout. ,
}
,
Required: False ,
}
enum ,
additionalOptions:
{
Description: The additional options. ,
Enum:
{
ProtectedAsyncOperationPolling: No description available. ,
ProtectedAsyncOperationPollingAuditOnly: No description available. ,
}
,
Required: False ,
}
enum ,
crossTenantTokenValidation:
{
Description: The cross tenant token validation. ,
Enum:
{
EnsureSecureValidation: No description available. ,
PassthroughInsecureToken: No description available. ,
}
,
Required: False ,
}
enum ,
regionality:
{
Description: The regionality. ,
Enum:
{
NotSpecified: No description available. ,
Global: No description available. ,
Regional: No description available. ,
}
,
Required: False ,
}
enum ,
endpoints:
{
Description: The extensions. ,
Required: False ,
}
[
{
kind:
{
Description: Resource type endpoint kind. This Metadata is also used by portal/tooling/etc to render different UX experiences for resources of the same type. ,
Enum:
{
Managed: Endpoint served by ProviderHub service ,
Direct: Endpoint served by the onboarded Resource Provider Service. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: Whether the endpoint is enabled. ,
Required: False ,
}
boolean ,
apiVersions:
{
Description: The api versions. ,
Required: False ,
}
[
string ,
]
,
locations:
{
Description: The locations. ,
Required: False ,
}
[
string ,
]
,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
featuresRule:
{
Description: The features rule. ,
Required: False ,
}
string ,
extensions:
{
Description: The extensions. ,
Required: False ,
}
[
{
endpointUri:
{
Description: The endpoint uri. ,
Required: False ,
}
string ,
extensionCategories:
{
Description: The extension categories. ,
Required: False ,
}
[
string ,
]
,
timeout:
{
Description: The timeout. ,
Format: duration ,
Required: False ,
}
string ,
}
,
]
,
timeout:
{
Description: The timeout. ,
Format: duration ,
Required: False ,
}
string ,
endpointType:
{
Description: The endpoint type. ,
Enum:
{
NotSpecified: No description available. ,
Canary: No description available. ,
Production: No description available. ,
TestInProduction: No description available. ,
}
,
Required: False ,
}
enum ,
tokenAuthConfiguration:
{
Description: The token auth configuration. ,
Required: False ,
}
{
authenticationScheme:
{
Description: The authentication scheme. ,
Enum:
{
PoP: No description available. ,
Bearer: No description available. ,
}
,
Required: False ,
}
enum ,
signedRequestScope:
{
Description: The signed request scope. ,
Enum:
{
ResourceUri: No description available. ,
Endpoint: No description available. ,
}
,
Required: False ,
}
enum ,
disableCertificateAuthenticationFallback:
{
Description: Whether certification authentication fallback is disabled. ,
Required: False ,
}
boolean ,
}
,
skuLink:
{
Description: The sku link. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The endpoint uri. ,
Required: False ,
}
string ,
apiVersion:
{
Description: Api version. ,
Required: False ,
}
string ,
zones:
{
Description: List of zones. ,
Required: False ,
}
[
string ,
]
,
dstsConfiguration:
{
Description: The dsts configuration. ,
Required: False ,
}
string ,
dataBoundary:
{
Description: The data boundary. ,
Enum:
{
NotDefined: No description available. ,
Global: No description available. ,
EU: No description available. ,
US: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
extensionOptions:
{
Description: The extension options. ,
Required: False ,
}
string ,
marketplaceType:
{
Description: The marketplace type. ,
Enum:
{
NotSpecified: No description available. ,
AddOn: No description available. ,
Bypass: No description available. ,
Store: No description available. ,
}
,
Required: False ,
}
enum ,
swaggerSpecifications:
{
Description: The swagger specifications. ,
Required: False ,
}
[
{
apiVersions:
{
Description: The api versions. ,
Required: False ,
}
[
string ,
]
,
swaggerSpecFolderUri:
{
Description: The swagger spec folder uri. ,
Required: False ,
}
string ,
}
,
]
,
allowedUnauthorizedActions:
{
Description: The allowed unauthorized actions. ,
Required: False ,
}
[
string ,
]
,
allowedUnauthorizedActionsExtensions:
{
Description: The allowed unauthorized actions extensions. ,
Required: False ,
}
[
{
action:
{
Description: The action. ,
Required: False ,
}
string ,
intent:
{
Description: The intent. ,
Enum:
{
NOT_SPECIFIED: Default value. ,
LOW_PRIVILEGE: Data is not sensitive and ok to access. ,
DEFERRED_ACCESS_CHECK: Used for RP's using a custom authorization check outside of ARM. ,
RP_CONTRACT: RP contract allows certain operations to be unauthorized action. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
authorizationActionMappings:
{
Description: The authorization action mappings ,
Required: False ,
}
[
{
original:
{
Description: The original action name. ,
Required: False ,
}
string ,
desired:
{
Description: The desired action name. ,
Required: False ,
}
string ,
}
,
]
,
linkedAccessChecks:
{
Description: The linked access checks. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: False ,
}
string ,
linkedProperty:
{
Description: The linked property. ,
Required: False ,
}
string ,
linkedAction:
{
Description: The linked action. ,
Required: False ,
}
string ,
linkedActionVerb:
{
Description: The linked action verb. ,
Required: False ,
}
string ,
linkedType:
{
Description: The linked type. ,
Required: False ,
}
string ,
}
,
]
,
defaultApiVersion:
{
Description: The default api version. ,
Required: False ,
}
string ,
loggingRules:
{
Description: The logging rules. ,
Required: False ,
}
[
{
action:
{
Description: The action. ,
Required: True ,
}
string ,
direction:
{
Description: The direction. ,
Enum:
{
None: No description available. ,
Request: No description available. ,
Response: No description available. ,
}
,
Required: True ,
}
enum ,
detailLevel:
{
Description: The detail level. ,
Enum:
{
None: No description available. ,
Body: No description available. ,
}
,
Required: True ,
}
enum ,
hiddenPropertyPaths:
{
Description: The hidden property paths. ,
Required: False ,
}
string ,
}
,
]
,
throttlingRules:
{
Description: The throttling rules. ,
Required: False ,
}
[
{
action:
{
Description: The action. ,
Required: True ,
}
string ,
metrics:
{
Description: The metrics. ,
Required: True ,
}
[
{
type:
{
Description: The throttling metric type ,
Enum:
{
NotSpecified: No description available. ,
NumberOfRequests: No description available. ,
NumberOfResources: No description available. ,
}
,
Required: True ,
}
enum ,
limit:
{
Description: The limit. ,
Format: int64 ,
Required: True ,
}
integer ,
interval:
{
Description: The interval. ,
Format: duration ,
Required: False ,
}
string ,
}
,
]
,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
applicationId:
{
Description: The application id. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
featuresRule:
{
Description: The features rule. ,
Required: False ,
}
string ,
enableAsyncOperation:
{
Description: Whether async operation is enabled. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
enableThirdPartyS2S:
{
Description: Whether third party S2S is enabled. ,
Required: False ,
}
boolean ,
subscriptionLifecycleNotificationSpecifications:
{
Description: The subscription lifecycle notification specifications. ,
Required: False ,
}
string ,
isPureProxy:
{
Description: Whether it is pure proxy. ,
Required: False ,
}
boolean ,
identityManagement:
{
Description: The identity management. ,
Required: False ,
}
string ,
checkNameAvailabilitySpecifications:
{
Description: The check name availability specifications. ,
Required: False ,
}
string ,
disallowedActionVerbs:
{
Description: The disallowed action verbs. ,
Required: False ,
}
[
string ,
]
,
serviceTreeInfos:
{
Description: The service tree infos. ,
Required: False ,
}
[
{
serviceId:
{
Description: The service id. ,
Required: False ,
}
string ,
componentId:
{
Description: The component id. ,
Required: False ,
}
string ,
readiness:
{
Description: The readiness. ,
Enum:
{
ClosingDown: No description available. ,
Deprecated: No description available. ,
GA: No description available. ,
InDevelopment: No description available. ,
InternalOnly: No description available. ,
PrivatePreview: No description available. ,
PublicPreview: No description available. ,
RemovedFromARM: No description available. ,
Retired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
requestHeaderOptions:
{
Description: The request header options. ,
Required: False ,
}
string ,
subscriptionStateRules:
{
Description: The subscription state rules. ,
Required: False ,
}
[
{
state:
{
Description: The subscription state. ,
Enum:
{
NotDefined: No description available. ,
Enabled: No description available. ,
Warned: No description available. ,
PastDue: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
allowedActions:
{
Description: The allowed actions. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
templateDeploymentOptions:
{
Description: The template deployment options. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations. ,
Required: False ,
}
[
{
type:
{
Description: The type. ,
Enum:
{
NotSpecified: The extended location type is not specified. ,
CustomLocation: The extended location type is custom location. ,
EdgeZone: The extended location type is edge zone. ,
ArcZone: The extended location type is arc zone. ,
}
,
Required: False ,
}
enum ,
supportedPolicy:
{
Enum:
{
NotSpecified: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resourceMovePolicy:
{
Description: The resource move policy. ,
Required: False ,
}
string ,
resourceDeletionPolicy:
{
Description: The resource deletion policy. ,
Enum:
{
NotSpecified: No description available. ,
CascadeDeleteAll: No description available. ,
CascadeDeleteProxyOnlyChildren: No description available. ,
}
,
Required: False ,
}
enum ,
resourceConcurrencyControlOptions:
{
Description: The resource concurrency control options. ,
Required: False ,
}
object ,
resourceGraphConfiguration:
{
Description: The resource graph configuration. ,
Required: False ,
}
string ,
management:
{
Description: The resource provider management. ,
Required: False ,
}
string ,
openApiConfiguration:
{
Description: The open api configuration. ,
Required: False ,
}
{
validation:
{
Description: The open api validation. ,
Required: False ,
}
{
allowNoncompliantCollectionResponse:
{
Description: Indicates whether a non compliance response is allowed for a LIST call ,
Required: False ,
}
boolean ,
}
,
}
,
onBehalfOfTokens:
{
Description: The on behalf of tokens. ,
Required: False ,
}
{
actionName:
{
Description: The action name. ,
Required: False ,
}
string ,
lifeTime:
{
Description: This is a TimeSpan property. ,
Required: False ,
}
string ,
}
,
category:
{
Description: The category. ,
Enum:
{
None: No description available. ,
FreeForm: No description available. ,
Internal: No description available. ,
PureProxy: No description available. ,
}
,
Required: False ,
}
enum ,
resourceValidation:
{
Description: The resource validation. ,
Enum:
{
NotSpecified: No description available. ,
ReservedWords: No description available. ,
ProfaneWords: No description available. ,
}
,
Required: False ,
}
enum ,
disallowedEndUserOperations:
{
Description: The disallowed end user operations. ,
Required: False ,
}
[
string ,
]
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
skuLink:
{
Description: The sku link. ,
Required: False ,
}
string ,
quotaRule:
{
Description: The quota rule. ,
Required: False ,
}
{
quotaPolicy:
{
Description: The quota policy. ,
Enum:
{
Default: No description available. ,
None: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
locationRules:
{
Description: The location rules. ,
Required: False ,
}
[
{
policy:
{
Description: The policy. ,
Enum:
{
Default: No description available. ,
None: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
quotaId:
{
Description: The quota id. ,
Required: False ,
}
string ,
location:
{
Description: The location. ,
Required: False ,
}
string ,
}
,
]
,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
}
,
notifications:
{
Description: The notifications. ,
Required: False ,
}
[
{
notificationType:
{
Description: The notification type. ,
Enum:
{
Unspecified: No description available. ,
SubscriptionNotification: No description available. ,
}
,
Required: False ,
}
enum ,
skipNotifications:
{
Description: Whether notifications should be skipped. ,
Enum:
{
Unspecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
linkedNotificationRules:
{
Description: The linked notification rules. ,
Required: False ,
}
[
{
actions:
{
Description: The actions. ,
Required: False ,
}
[
string ,
]
,
actionsOnFailedOperation:
{
Description: The actions on failed operation. ,
Required: False ,
}
[
string ,
]
,
fastPathActions:
{
Description: The fast path actions. ,
Required: False ,
}
[
string ,
]
,
fastPathActionsOnFailedOperation:
{
Description: The fast path action on failed operation. ,
Required: False ,
}
[
string ,
]
,
linkedNotificationTimeout:
{
Description: This is a TimeSpan property. ,
Format: duration ,
Required: False ,
}
string ,
}
,
]
,
resourceProviderAuthorizationRules:
{
Description: The resource provider authorization rules. ,
Required: False ,
}
{
asyncOperationPollingRules:
{
Description: The async operation polling rules. ,
Required: False ,
}
{
authorizationActions:
{
Description: The authorization actions. ,
Required: False ,
}
[
string ,
]
,
additionalOptions:
{
Description: The additional options. ,
Enum:
{
ProtectedAsyncOperationPolling: No description available. ,
ProtectedAsyncOperationPollingAuditOnly: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
tokenAuthConfiguration:
{
Description: The token auth configuration. ,
Required: False ,
}
{
authenticationScheme:
{
Description: The authentication scheme. ,
Enum:
{
PoP: No description available. ,
Bearer: No description available. ,
}
,
Required: False ,
}
enum ,
signedRequestScope:
{
Description: The signed request scope. ,
Enum:
{
ResourceUri: No description available. ,
Endpoint: No description available. ,
}
,
Required: False ,
}
enum ,
disableCertificateAuthenticationFallback:
{
Description: Whether certification authentication fallback is disabled. ,
Required: False ,
}
boolean ,
}
,
templateDeploymentPolicy:
{
Description: The template deployment policy. ,
Required: False ,
}
string ,
allowEmptyRoleAssignments:
{
Description: The allow empty role assignments. ,
Required: False ,
}
boolean ,
policyExecutionType:
{
Description: The policy execution type. ,
Enum:
{
NotSpecified: No description available. ,
ExecutePolicies: No description available. ,
BypassPolicies: No description available. ,
ExpectPartialPutRequests: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityZoneRule:
{
Description: The availability zone rule. ,
Required: False ,
}
{
availabilityZonePolicy:
{
Enum:
{
NotSpecified: No description available. ,
SingleZoned: No description available. ,
MultiZoned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dstsConfiguration:
{
Description: The dsts configuration. ,
Required: False ,
}
string ,
asyncTimeoutRules:
{
Description: Async timeout rules ,
Required: False ,
}
[
{
actionName:
{
Required: False ,
}
string ,
timeout:
{
Description: This is a TimeSpan property ,
Required: False ,
}
string ,
}
,
]
,
commonApiVersions:
{
Description: Common API versions for the resource type. ,
Required: False ,
}
[
string ,
]
,
apiProfiles:
{
Description: The api profiles. ,
Required: False ,
}
[
{
profileVersion:
{
Description: Profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: Api version. ,
Required: False ,
}
string ,
}
,
]
,
linkedOperationRules:
{
Description: The linked operation rules. ,
Required: False ,
}
[
{
linkedOperation:
{
Description: The linked operation. ,
Enum:
{
None: No description available. ,
CrossResourceGroupResourceMove: No description available. ,
CrossSubscriptionResourceMove: No description available. ,
}
,
Required: True ,
}
enum ,
linkedAction:
{
Description: The linked action. ,
Enum:
{
NotSpecified: No description available. ,
Blocked: No description available. ,
Validate: No description available. ,
Enabled: No description available. ,
}
,
Required: True ,
}
enum ,
dependsOnTypes:
{
Description: Depends on types. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
legacyName:
{
Description: The legacy name. ,
Required: False ,
}
string ,
legacyNames:
{
Description: The legacy names. ,
Required: False ,
}
[
string ,
]
,
allowedTemplateDeploymentReferenceActions:
{
Description: Allowed template deployment reference actions. ,
Required: False ,
}
[
string ,
]
,
legacyPolicy:
{
Description: The legacy policy. ,
Required: False ,
}
{
disallowedLegacyOperations:
{
Required: False ,
}
[
string ,
]
,
disallowedConditions:
{
Required: False ,
}
[
{
disallowedLegacyOperations:
{
Description: The disallowed legacy operations. ,
Required: False ,
}
[
string ,
]
,
feature:
{
Description: Feature string. ,
Required: False ,
}
string ,
}
,
]
,
}
,
manifestLink:
{
Description: Manifest link. ,
Required: False ,
}
string ,
capacityRule:
{
Description: Capacity rule. ,
Required: False ,
}
{
capacityPolicy:
{
Description: Capacity policy. ,
Enum:
{
Default: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
skuAlias:
{
Description: Sku alias ,
Required: False ,
}
string ,
}
,
marketplaceOptions:
{
Description: Marketplace options. ,
Required: False ,
}
{
addOnPlanConversionAllowed:
{
Description: Add-on plan conversion allowed. ,
Required: False ,
}
boolean ,
}
,
allowedResourceNames:
{
Description: The allowed resource names. ,
Required: False ,
}
[
{
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
getActionVerb:
{
Description: Get action verb. ,
Required: False ,
}
string ,
}
,
]
,
resourceCache:
{
Description: Resource cache options. ,
Required: False ,
}
{
enableResourceCache:
{
Description: Enable resource cache. ,
Required: False ,
}
boolean ,
resourceCacheExpirationTimespan:
{
Description: Resource cache expiration timespan. This is a TimeSpan property. ,
Required: False ,
}
string ,
}
,
resourceQueryManagement:
{
Description: Resource query management options. ,
Required: False ,
}
{
filterOption:
{
Description: Filter option. ,
Enum:
{
NotSpecified: No description available. ,
EnableSubscriptionFilterOnTenant: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
supportsTags:
{
Description: Whether tags are supported. ,
Required: False ,
}
boolean ,
resourceManagementOptions:
{
Description: Resource management options. ,
Required: False ,
}
{
batchProvisioningSupport:
{
Description: Batch provisioning support. ,
Required: False ,
}
{
supportedOperations:
{
Description: Supported operations. ,
Enum:
{
NotSpecified: No description available. ,
Get: No description available. ,
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
deleteDependencies:
{
Description: Delete dependencies. ,
Required: False ,
}
[
{
requiredFeatures:
{
Description: Required features. ,
Required: False ,
}
[
string ,
]
,
linkedProperty:
{
Description: Linked property. ,
Required: False ,
}
string ,
linkedType:
{
Description: Linked type. ,
Required: False ,
}
string ,
}
,
]
,
nestedProvisioningSupport:
{
Description: Nested provisioning support. ,
Required: False ,
}
{
minimumApiVersion:
{
Description: Minimum API version. ,
Required: False ,
}
string ,
}
,
}
,
groupingTag:
{
Description: Grouping tag. ,
Required: False ,
}
string ,
addResourceListTargetLocations:
{
Description: Add resource list target locations? ,
Required: False ,
}
boolean ,
resourceTypeCommonAttributeManagement:
{
Description: Resource type common attribute management. ,
Required: False ,
}
{
commonApiVersionsMergeMode:
{
Description: Common api versions merge mode. ,
Enum:
{
Merge: No description available. ,
Overwrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
routingRule:
{
Description: Routing rule. ,
Required: False ,
}
{
hostResourceType:
{
Description: Hosted resource type. ,
Required: False ,
}
string ,
}
,
frontdoorRequestMode:
{
Description: The frontdoor request mode. ,
Enum:
{
NotSpecified: No description available. ,
UseManifest: No description available. ,
}
,
Required: False ,
}
enum ,
resourceSubType:
{
Description: The resource sub type. ,
Enum:
{
NotSpecified: No description available. ,
AsyncOperation: No description available. ,
}
,
Required: False ,
}
enum ,
asyncOperationResourceTypeName:
{
Description: The async operation resource type name. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
kind:
{
Description: Resource type registration kind. This Metadata is also used by portal/tooling/etc to render different UX experiences for resources of the same type. ,
Enum:
{
Managed: Resource type served by the ProviderHub service. ,
Hybrid: Resource type served by both the ProviderHub & the onboarded Resource Provider Services (i.e. The type has a mix of managed and direct endpoints). ,
Direct: Resource type served by the onboarded Resource Provider Service. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
routingType:
{
Description: The resource routing type. ,
Enum:
{
Default: The resource routing type is default. ,
ProxyOnly: The resource routing type is proxy only. ,
HostBased: The resource routing type is host based. ,
Extension: The resource routing type is extension. ,
Tenant: The resource routing type is tenant. ,
Fanout: The resource routing type is fanout. ,
LocationBased: The resource routing type is location based. ,
Failover: The resource routing type is failover. ,
CascadeExtension: The resource routing type is cascade extension. ,
ChildFanout: The resource routing type is child fanout. ,
CascadeAuthorizedExtension: The resource routing type is cascade authorized extension. ,
BypassEndpointSelectionOptimization: The resource routing type is bypass endpoint selection optimization. ,
LocationMapping: The resource routing type is location mapping. ,
ServiceFanout: The resource routing type is service fanout. ,
}
,
Required: False ,
}
enum ,
additionalOptions:
{
Description: The additional options. ,
Enum:
{
ProtectedAsyncOperationPolling: No description available. ,
ProtectedAsyncOperationPollingAuditOnly: No description available. ,
}
,
Required: False ,
}
enum ,
crossTenantTokenValidation:
{
Description: The cross tenant token validation. ,
Enum:
{
EnsureSecureValidation: No description available. ,
PassthroughInsecureToken: No description available. ,
}
,
Required: False ,
}
enum ,
regionality:
{
Description: The regionality. ,
Enum:
{
NotSpecified: No description available. ,
Global: No description available. ,
Regional: No description available. ,
}
,
Required: False ,
}
enum ,
endpoints:
{
Description: The extensions. ,
Required: False ,
}
[
{
kind:
{
Description: Resource type endpoint kind. This Metadata is also used by portal/tooling/etc to render different UX experiences for resources of the same type. ,
Enum:
{
Managed: Endpoint served by ProviderHub service ,
Direct: Endpoint served by the onboarded Resource Provider Service. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: Whether the endpoint is enabled. ,
Required: False ,
}
boolean ,
apiVersions:
{
Description: The api versions. ,
Required: False ,
}
[
string ,
]
,
locations:
{
Description: The locations. ,
Required: False ,
}
[
string ,
]
,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
featuresRule:
{
Description: The features rule. ,
Required: False ,
}
string ,
extensions:
{
Description: The extensions. ,
Required: False ,
}
[
{
endpointUri:
{
Description: The endpoint uri. ,
Required: False ,
}
string ,
extensionCategories:
{
Description: The extension categories. ,
Required: False ,
}
[
string ,
]
,
timeout:
{
Description: The timeout. ,
Format: duration ,
Required: False ,
}
string ,
}
,
]
,
timeout:
{
Description: The timeout. ,
Format: duration ,
Required: False ,
}
string ,
endpointType:
{
Description: The endpoint type. ,
Enum:
{
NotSpecified: No description available. ,
Canary: No description available. ,
Production: No description available. ,
TestInProduction: No description available. ,
}
,
Required: False ,
}
enum ,
tokenAuthConfiguration:
{
Description: The token auth configuration. ,
Required: False ,
}
{
authenticationScheme:
{
Description: The authentication scheme. ,
Enum:
{
PoP: No description available. ,
Bearer: No description available. ,
}
,
Required: False ,
}
enum ,
signedRequestScope:
{
Description: The signed request scope. ,
Enum:
{
ResourceUri: No description available. ,
Endpoint: No description available. ,
}
,
Required: False ,
}
enum ,
disableCertificateAuthenticationFallback:
{
Description: Whether certification authentication fallback is disabled. ,
Required: False ,
}
boolean ,
}
,
skuLink:
{
Description: The sku link. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The endpoint uri. ,
Required: False ,
}
string ,
apiVersion:
{
Description: Api version. ,
Required: False ,
}
string ,
zones:
{
Description: List of zones. ,
Required: False ,
}
[
string ,
]
,
dstsConfiguration:
{
Description: The dsts configuration. ,
Required: False ,
}
string ,
dataBoundary:
{
Description: The data boundary. ,
Enum:
{
NotDefined: No description available. ,
Global: No description available. ,
EU: No description available. ,
US: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
extensionOptions:
{
Description: The extension options. ,
Required: False ,
}
string ,
marketplaceType:
{
Description: The marketplace type. ,
Enum:
{
NotSpecified: No description available. ,
AddOn: No description available. ,
Bypass: No description available. ,
Store: No description available. ,
}
,
Required: False ,
}
enum ,
swaggerSpecifications:
{
Description: The swagger specifications. ,
Required: False ,
}
[
{
apiVersions:
{
Description: The api versions. ,
Required: False ,
}
[
string ,
]
,
swaggerSpecFolderUri:
{
Description: The swagger spec folder uri. ,
Required: False ,
}
string ,
}
,
]
,
allowedUnauthorizedActions:
{
Description: The allowed unauthorized actions. ,
Required: False ,
}
[
string ,
]
,
allowedUnauthorizedActionsExtensions:
{
Description: The allowed unauthorized actions extensions. ,
Required: False ,
}
[
{
action:
{
Description: The action. ,
Required: False ,
}
string ,
intent:
{
Description: The intent. ,
Enum:
{
NOT_SPECIFIED: Default value. ,
LOW_PRIVILEGE: Data is not sensitive and ok to access. ,
DEFERRED_ACCESS_CHECK: Used for RP's using a custom authorization check outside of ARM. ,
RP_CONTRACT: RP contract allows certain operations to be unauthorized action. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
authorizationActionMappings:
{
Description: The authorization action mappings ,
Required: False ,
}
[
{
original:
{
Description: The original action name. ,
Required: False ,
}
string ,
desired:
{
Description: The desired action name. ,
Required: False ,
}
string ,
}
,
]
,
linkedAccessChecks:
{
Description: The linked access checks. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: False ,
}
string ,
linkedProperty:
{
Description: The linked property. ,
Required: False ,
}
string ,
linkedAction:
{
Description: The linked action. ,
Required: False ,
}
string ,
linkedActionVerb:
{
Description: The linked action verb. ,
Required: False ,
}
string ,
linkedType:
{
Description: The linked type. ,
Required: False ,
}
string ,
}
,
]
,
defaultApiVersion:
{
Description: The default api version. ,
Required: False ,
}
string ,
loggingRules:
{
Description: The logging rules. ,
Required: False ,
}
[
{
action:
{
Description: The action. ,
Required: True ,
}
string ,
direction:
{
Description: The direction. ,
Enum:
{
None: No description available. ,
Request: No description available. ,
Response: No description available. ,
}
,
Required: True ,
}
enum ,
detailLevel:
{
Description: The detail level. ,
Enum:
{
None: No description available. ,
Body: No description available. ,
}
,
Required: True ,
}
enum ,
hiddenPropertyPaths:
{
Description: The hidden property paths. ,
Required: False ,
}
string ,
}
,
]
,
throttlingRules:
{
Description: The throttling rules. ,
Required: False ,
}
[
{
action:
{
Description: The action. ,
Required: True ,
}
string ,
metrics:
{
Description: The metrics. ,
Required: True ,
}
[
{
type:
{
Description: The throttling metric type ,
Enum:
{
NotSpecified: No description available. ,
NumberOfRequests: No description available. ,
NumberOfResources: No description available. ,
}
,
Required: True ,
}
enum ,
limit:
{
Description: The limit. ,
Format: int64 ,
Required: True ,
}
integer ,
interval:
{
Description: The interval. ,
Format: duration ,
Required: False ,
}
string ,
}
,
]
,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
applicationId:
{
Description: The application id. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
featuresRule:
{
Description: The features rule. ,
Required: False ,
}
string ,
enableAsyncOperation:
{
Description: Whether async operation is enabled. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
enableThirdPartyS2S:
{
Description: Whether third party S2S is enabled. ,
Required: False ,
}
boolean ,
subscriptionLifecycleNotificationSpecifications:
{
Description: The subscription lifecycle notification specifications. ,
Required: False ,
}
string ,
isPureProxy:
{
Description: Whether it is pure proxy. ,
Required: False ,
}
boolean ,
identityManagement:
{
Description: The identity management. ,
Required: False ,
}
string ,
checkNameAvailabilitySpecifications:
{
Description: The check name availability specifications. ,
Required: False ,
}
string ,
disallowedActionVerbs:
{
Description: The disallowed action verbs. ,
Required: False ,
}
[
string ,
]
,
serviceTreeInfos:
{
Description: The service tree infos. ,
Required: False ,
}
[
{
serviceId:
{
Description: The service id. ,
Required: False ,
}
string ,
componentId:
{
Description: The component id. ,
Required: False ,
}
string ,
readiness:
{
Description: The readiness. ,
Enum:
{
ClosingDown: No description available. ,
Deprecated: No description available. ,
GA: No description available. ,
InDevelopment: No description available. ,
InternalOnly: No description available. ,
PrivatePreview: No description available. ,
PublicPreview: No description available. ,
RemovedFromARM: No description available. ,
Retired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
requestHeaderOptions:
{
Description: The request header options. ,
Required: False ,
}
string ,
subscriptionStateRules:
{
Description: The subscription state rules. ,
Required: False ,
}
[
{
state:
{
Description: The subscription state. ,
Enum:
{
NotDefined: No description available. ,
Enabled: No description available. ,
Warned: No description available. ,
PastDue: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
allowedActions:
{
Description: The allowed actions. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
templateDeploymentOptions:
{
Description: The template deployment options. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations. ,
Required: False ,
}
[
{
type:
{
Description: The type. ,
Enum:
{
NotSpecified: The extended location type is not specified. ,
CustomLocation: The extended location type is custom location. ,
EdgeZone: The extended location type is edge zone. ,
ArcZone: The extended location type is arc zone. ,
}
,
Required: False ,
}
enum ,
supportedPolicy:
{
Enum:
{
NotSpecified: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resourceMovePolicy:
{
Description: The resource move policy. ,
Required: False ,
}
string ,
resourceDeletionPolicy:
{
Description: The resource deletion policy. ,
Enum:
{
NotSpecified: No description available. ,
CascadeDeleteAll: No description available. ,
CascadeDeleteProxyOnlyChildren: No description available. ,
}
,
Required: False ,
}
enum ,
resourceConcurrencyControlOptions:
{
Description: The resource concurrency control options. ,
Required: False ,
}
object ,
resourceGraphConfiguration:
{
Description: The resource graph configuration. ,
Required: False ,
}
string ,
management:
{
Description: The resource provider management. ,
Required: False ,
}
string ,
openApiConfiguration:
{
Description: The open api configuration. ,
Required: False ,
}
{
validation:
{
Description: The open api validation. ,
Required: False ,
}
{
allowNoncompliantCollectionResponse:
{
Description: Indicates whether a non compliance response is allowed for a LIST call ,
Required: False ,
}
boolean ,
}
,
}
,
onBehalfOfTokens:
{
Description: The on behalf of tokens. ,
Required: False ,
}
{
actionName:
{
Description: The action name. ,
Required: False ,
}
string ,
lifeTime:
{
Description: This is a TimeSpan property. ,
Required: False ,
}
string ,
}
,
category:
{
Description: The category. ,
Enum:
{
None: No description available. ,
FreeForm: No description available. ,
Internal: No description available. ,
PureProxy: No description available. ,
}
,
Required: False ,
}
enum ,
resourceValidation:
{
Description: The resource validation. ,
Enum:
{
NotSpecified: No description available. ,
ReservedWords: No description available. ,
ProfaneWords: No description available. ,
}
,
Required: False ,
}
enum ,
disallowedEndUserOperations:
{
Description: The disallowed end user operations. ,
Required: False ,
}
[
string ,
]
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
skuLink:
{
Description: The sku link. ,
Required: False ,
}
string ,
quotaRule:
{
Description: The quota rule. ,
Required: False ,
}
{
quotaPolicy:
{
Description: The quota policy. ,
Enum:
{
Default: No description available. ,
None: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
locationRules:
{
Description: The location rules. ,
Required: False ,
}
[
{
policy:
{
Description: The policy. ,
Enum:
{
Default: No description available. ,
None: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
quotaId:
{
Description: The quota id. ,
Required: False ,
}
string ,
location:
{
Description: The location. ,
Required: False ,
}
string ,
}
,
]
,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
}
,
notifications:
{
Description: The notifications. ,
Required: False ,
}
[
{
notificationType:
{
Description: The notification type. ,
Enum:
{
Unspecified: No description available. ,
SubscriptionNotification: No description available. ,
}
,
Required: False ,
}
enum ,
skipNotifications:
{
Description: Whether notifications should be skipped. ,
Enum:
{
Unspecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
linkedNotificationRules:
{
Description: The linked notification rules. ,
Required: False ,
}
[
{
actions:
{
Description: The actions. ,
Required: False ,
}
[
string ,
]
,
actionsOnFailedOperation:
{
Description: The actions on failed operation. ,
Required: False ,
}
[
string ,
]
,
fastPathActions:
{
Description: The fast path actions. ,
Required: False ,
}
[
string ,
]
,
fastPathActionsOnFailedOperation:
{
Description: The fast path action on failed operation. ,
Required: False ,
}
[
string ,
]
,
linkedNotificationTimeout:
{
Description: This is a TimeSpan property. ,
Format: duration ,
Required: False ,
}
string ,
}
,
]
,
resourceProviderAuthorizationRules:
{
Description: The resource provider authorization rules. ,
Required: False ,
}
{
asyncOperationPollingRules:
{
Description: The async operation polling rules. ,
Required: False ,
}
{
authorizationActions:
{
Description: The authorization actions. ,
Required: False ,
}
[
string ,
]
,
additionalOptions:
{
Description: The additional options. ,
Enum:
{
ProtectedAsyncOperationPolling: No description available. ,
ProtectedAsyncOperationPollingAuditOnly: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
tokenAuthConfiguration:
{
Description: The token auth configuration. ,
Required: False ,
}
{
authenticationScheme:
{
Description: The authentication scheme. ,
Enum:
{
PoP: No description available. ,
Bearer: No description available. ,
}
,
Required: False ,
}
enum ,
signedRequestScope:
{
Description: The signed request scope. ,
Enum:
{
ResourceUri: No description available. ,
Endpoint: No description available. ,
}
,
Required: False ,
}
enum ,
disableCertificateAuthenticationFallback:
{
Description: Whether certification authentication fallback is disabled. ,
Required: False ,
}
boolean ,
}
,
templateDeploymentPolicy:
{
Description: The template deployment policy. ,
Required: False ,
}
string ,
allowEmptyRoleAssignments:
{
Description: The allow empty role assignments. ,
Required: False ,
}
boolean ,
policyExecutionType:
{
Description: The policy execution type. ,
Enum:
{
NotSpecified: No description available. ,
ExecutePolicies: No description available. ,
BypassPolicies: No description available. ,
ExpectPartialPutRequests: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityZoneRule:
{
Description: The availability zone rule. ,
Required: False ,
}
{
availabilityZonePolicy:
{
Enum:
{
NotSpecified: No description available. ,
SingleZoned: No description available. ,
MultiZoned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dstsConfiguration:
{
Description: The dsts configuration. ,
Required: False ,
}
string ,
asyncTimeoutRules:
{
Description: Async timeout rules ,
Required: False ,
}
[
{
actionName:
{
Required: False ,
}
string ,
timeout:
{
Description: This is a TimeSpan property ,
Required: False ,
}
string ,
}
,
]
,
commonApiVersions:
{
Description: Common API versions for the resource type. ,
Required: False ,
}
[
string ,
]
,
apiProfiles:
{
Description: The api profiles. ,
Required: False ,
}
[
{
profileVersion:
{
Description: Profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: Api version. ,
Required: False ,
}
string ,
}
,
]
,
linkedOperationRules:
{
Description: The linked operation rules. ,
Required: False ,
}
[
{
linkedOperation:
{
Description: The linked operation. ,
Enum:
{
None: No description available. ,
CrossResourceGroupResourceMove: No description available. ,
CrossSubscriptionResourceMove: No description available. ,
}
,
Required: True ,
}
enum ,
linkedAction:
{
Description: The linked action. ,
Enum:
{
NotSpecified: No description available. ,
Blocked: No description available. ,
Validate: No description available. ,
Enabled: No description available. ,
}
,
Required: True ,
}
enum ,
dependsOnTypes:
{
Description: Depends on types. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
legacyName:
{
Description: The legacy name. ,
Required: False ,
}
string ,
legacyNames:
{
Description: The legacy names. ,
Required: False ,
}
[
string ,
]
,
allowedTemplateDeploymentReferenceActions:
{
Description: Allowed template deployment reference actions. ,
Required: False ,
}
[
string ,
]
,
legacyPolicy:
{
Description: The legacy policy. ,
Required: False ,
}
{
disallowedLegacyOperations:
{
Required: False ,
}
[
string ,
]
,
disallowedConditions:
{
Required: False ,
}
[
{
disallowedLegacyOperations:
{
Description: The disallowed legacy operations. ,
Required: False ,
}
[
string ,
]
,
feature:
{
Description: Feature string. ,
Required: False ,
}
string ,
}
,
]
,
}
,
manifestLink:
{
Description: Manifest link. ,
Required: False ,
}
string ,
capacityRule:
{
Description: Capacity rule. ,
Required: False ,
}
{
capacityPolicy:
{
Description: Capacity policy. ,
Enum:
{
Default: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
skuAlias:
{
Description: Sku alias ,
Required: False ,
}
string ,
}
,
marketplaceOptions:
{
Description: Marketplace options. ,
Required: False ,
}
{
addOnPlanConversionAllowed:
{
Description: Add-on plan conversion allowed. ,
Required: False ,
}
boolean ,
}
,
allowedResourceNames:
{
Description: The allowed resource names. ,
Required: False ,
}
[
{
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
getActionVerb:
{
Description: Get action verb. ,
Required: False ,
}
string ,
}
,
]
,
resourceCache:
{
Description: Resource cache options. ,
Required: False ,
}
{
enableResourceCache:
{
Description: Enable resource cache. ,
Required: False ,
}
boolean ,
resourceCacheExpirationTimespan:
{
Description: Resource cache expiration timespan. This is a TimeSpan property. ,
Required: False ,
}
string ,
}
,
resourceQueryManagement:
{
Description: Resource query management options. ,
Required: False ,
}
{
filterOption:
{
Description: Filter option. ,
Enum:
{
NotSpecified: No description available. ,
EnableSubscriptionFilterOnTenant: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
supportsTags:
{
Description: Whether tags are supported. ,
Required: False ,
}
boolean ,
resourceManagementOptions:
{
Description: Resource management options. ,
Required: False ,
}
{
batchProvisioningSupport:
{
Description: Batch provisioning support. ,
Required: False ,
}
{
supportedOperations:
{
Description: Supported operations. ,
Enum:
{
NotSpecified: No description available. ,
Get: No description available. ,
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
deleteDependencies:
{
Description: Delete dependencies. ,
Required: False ,
}
[
{
requiredFeatures:
{
Description: Required features. ,
Required: False ,
}
[
string ,
]
,
linkedProperty:
{
Description: Linked property. ,
Required: False ,
}
string ,
linkedType:
{
Description: Linked type. ,
Required: False ,
}
string ,
}
,
]
,
nestedProvisioningSupport:
{
Description: Nested provisioning support. ,
Required: False ,
}
{
minimumApiVersion:
{
Description: Minimum API version. ,
Required: False ,
}
string ,
}
,
}
,
groupingTag:
{
Description: Grouping tag. ,
Required: False ,
}
string ,
addResourceListTargetLocations:
{
Description: Add resource list target locations? ,
Required: False ,
}
boolean ,
resourceTypeCommonAttributeManagement:
{
Description: Resource type common attribute management. ,
Required: False ,
}
{
commonApiVersionsMergeMode:
{
Description: Common api versions merge mode. ,
Enum:
{
Merge: No description available. ,
Overwrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
routingRule:
{
Description: Routing rule. ,
Required: False ,
}
{
hostResourceType:
{
Description: Hosted resource type. ,
Required: False ,
}
string ,
}
,
frontdoorRequestMode:
{
Description: The frontdoor request mode. ,
Enum:
{
NotSpecified: No description available. ,
UseManifest: No description available. ,
}
,
Required: False ,
}
enum ,
resourceSubType:
{
Description: The resource sub type. ,
Enum:
{
NotSpecified: No description available. ,
AsyncOperation: No description available. ,
}
,
Required: False ,
}
enum ,
asyncOperationResourceTypeName:
{
Description: The async operation resource type name. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
kind:
{
Description: Resource type registration kind. This Metadata is also used by portal/tooling/etc to render different UX experiences for resources of the same type. ,
Enum:
{
Managed: Resource type served by the ProviderHub service. ,
Hybrid: Resource type served by both the ProviderHub & the onboarded Resource Provider Services (i.e. The type has a mix of managed and direct endpoints). ,
Direct: Resource type served by the onboarded Resource Provider Service. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (201)

{
properties:
{
Required: False ,
}
{
routingType:
{
Description: The resource routing type. ,
Enum:
{
Default: The resource routing type is default. ,
ProxyOnly: The resource routing type is proxy only. ,
HostBased: The resource routing type is host based. ,
Extension: The resource routing type is extension. ,
Tenant: The resource routing type is tenant. ,
Fanout: The resource routing type is fanout. ,
LocationBased: The resource routing type is location based. ,
Failover: The resource routing type is failover. ,
CascadeExtension: The resource routing type is cascade extension. ,
ChildFanout: The resource routing type is child fanout. ,
CascadeAuthorizedExtension: The resource routing type is cascade authorized extension. ,
BypassEndpointSelectionOptimization: The resource routing type is bypass endpoint selection optimization. ,
LocationMapping: The resource routing type is location mapping. ,
ServiceFanout: The resource routing type is service fanout. ,
}
,
Required: False ,
}
enum ,
additionalOptions:
{
Description: The additional options. ,
Enum:
{
ProtectedAsyncOperationPolling: No description available. ,
ProtectedAsyncOperationPollingAuditOnly: No description available. ,
}
,
Required: False ,
}
enum ,
crossTenantTokenValidation:
{
Description: The cross tenant token validation. ,
Enum:
{
EnsureSecureValidation: No description available. ,
PassthroughInsecureToken: No description available. ,
}
,
Required: False ,
}
enum ,
regionality:
{
Description: The regionality. ,
Enum:
{
NotSpecified: No description available. ,
Global: No description available. ,
Regional: No description available. ,
}
,
Required: False ,
}
enum ,
endpoints:
{
Description: The extensions. ,
Required: False ,
}
[
{
kind:
{
Description: Resource type endpoint kind. This Metadata is also used by portal/tooling/etc to render different UX experiences for resources of the same type. ,
Enum:
{
Managed: Endpoint served by ProviderHub service ,
Direct: Endpoint served by the onboarded Resource Provider Service. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: Whether the endpoint is enabled. ,
Required: False ,
}
boolean ,
apiVersions:
{
Description: The api versions. ,
Required: False ,
}
[
string ,
]
,
locations:
{
Description: The locations. ,
Required: False ,
}
[
string ,
]
,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
featuresRule:
{
Description: The features rule. ,
Required: False ,
}
string ,
extensions:
{
Description: The extensions. ,
Required: False ,
}
[
{
endpointUri:
{
Description: The endpoint uri. ,
Required: False ,
}
string ,
extensionCategories:
{
Description: The extension categories. ,
Required: False ,
}
[
string ,
]
,
timeout:
{
Description: The timeout. ,
Format: duration ,
Required: False ,
}
string ,
}
,
]
,
timeout:
{
Description: The timeout. ,
Format: duration ,
Required: False ,
}
string ,
endpointType:
{
Description: The endpoint type. ,
Enum:
{
NotSpecified: No description available. ,
Canary: No description available. ,
Production: No description available. ,
TestInProduction: No description available. ,
}
,
Required: False ,
}
enum ,
tokenAuthConfiguration:
{
Description: The token auth configuration. ,
Required: False ,
}
{
authenticationScheme:
{
Description: The authentication scheme. ,
Enum:
{
PoP: No description available. ,
Bearer: No description available. ,
}
,
Required: False ,
}
enum ,
signedRequestScope:
{
Description: The signed request scope. ,
Enum:
{
ResourceUri: No description available. ,
Endpoint: No description available. ,
}
,
Required: False ,
}
enum ,
disableCertificateAuthenticationFallback:
{
Description: Whether certification authentication fallback is disabled. ,
Required: False ,
}
boolean ,
}
,
skuLink:
{
Description: The sku link. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The endpoint uri. ,
Required: False ,
}
string ,
apiVersion:
{
Description: Api version. ,
Required: False ,
}
string ,
zones:
{
Description: List of zones. ,
Required: False ,
}
[
string ,
]
,
dstsConfiguration:
{
Description: The dsts configuration. ,
Required: False ,
}
string ,
dataBoundary:
{
Description: The data boundary. ,
Enum:
{
NotDefined: No description available. ,
Global: No description available. ,
EU: No description available. ,
US: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
extensionOptions:
{
Description: The extension options. ,
Required: False ,
}
string ,
marketplaceType:
{
Description: The marketplace type. ,
Enum:
{
NotSpecified: No description available. ,
AddOn: No description available. ,
Bypass: No description available. ,
Store: No description available. ,
}
,
Required: False ,
}
enum ,
swaggerSpecifications:
{
Description: The swagger specifications. ,
Required: False ,
}
[
{
apiVersions:
{
Description: The api versions. ,
Required: False ,
}
[
string ,
]
,
swaggerSpecFolderUri:
{
Description: The swagger spec folder uri. ,
Required: False ,
}
string ,
}
,
]
,
allowedUnauthorizedActions:
{
Description: The allowed unauthorized actions. ,
Required: False ,
}
[
string ,
]
,
allowedUnauthorizedActionsExtensions:
{
Description: The allowed unauthorized actions extensions. ,
Required: False ,
}
[
{
action:
{
Description: The action. ,
Required: False ,
}
string ,
intent:
{
Description: The intent. ,
Enum:
{
NOT_SPECIFIED: Default value. ,
LOW_PRIVILEGE: Data is not sensitive and ok to access. ,
DEFERRED_ACCESS_CHECK: Used for RP's using a custom authorization check outside of ARM. ,
RP_CONTRACT: RP contract allows certain operations to be unauthorized action. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
authorizationActionMappings:
{
Description: The authorization action mappings ,
Required: False ,
}
[
{
original:
{
Description: The original action name. ,
Required: False ,
}
string ,
desired:
{
Description: The desired action name. ,
Required: False ,
}
string ,
}
,
]
,
linkedAccessChecks:
{
Description: The linked access checks. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: False ,
}
string ,
linkedProperty:
{
Description: The linked property. ,
Required: False ,
}
string ,
linkedAction:
{
Description: The linked action. ,
Required: False ,
}
string ,
linkedActionVerb:
{
Description: The linked action verb. ,
Required: False ,
}
string ,
linkedType:
{
Description: The linked type. ,
Required: False ,
}
string ,
}
,
]
,
defaultApiVersion:
{
Description: The default api version. ,
Required: False ,
}
string ,
loggingRules:
{
Description: The logging rules. ,
Required: False ,
}
[
{
action:
{
Description: The action. ,
Required: True ,
}
string ,
direction:
{
Description: The direction. ,
Enum:
{
None: No description available. ,
Request: No description available. ,
Response: No description available. ,
}
,
Required: True ,
}
enum ,
detailLevel:
{
Description: The detail level. ,
Enum:
{
None: No description available. ,
Body: No description available. ,
}
,
Required: True ,
}
enum ,
hiddenPropertyPaths:
{
Description: The hidden property paths. ,
Required: False ,
}
string ,
}
,
]
,
throttlingRules:
{
Description: The throttling rules. ,
Required: False ,
}
[
{
action:
{
Description: The action. ,
Required: True ,
}
string ,
metrics:
{
Description: The metrics. ,
Required: True ,
}
[
{
type:
{
Description: The throttling metric type ,
Enum:
{
NotSpecified: No description available. ,
NumberOfRequests: No description available. ,
NumberOfResources: No description available. ,
}
,
Required: True ,
}
enum ,
limit:
{
Description: The limit. ,
Format: int64 ,
Required: True ,
}
integer ,
interval:
{
Description: The interval. ,
Format: duration ,
Required: False ,
}
string ,
}
,
]
,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
applicationId:
{
Description: The application id. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
featuresRule:
{
Description: The features rule. ,
Required: False ,
}
string ,
enableAsyncOperation:
{
Description: Whether async operation is enabled. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
enableThirdPartyS2S:
{
Description: Whether third party S2S is enabled. ,
Required: False ,
}
boolean ,
subscriptionLifecycleNotificationSpecifications:
{
Description: The subscription lifecycle notification specifications. ,
Required: False ,
}
string ,
isPureProxy:
{
Description: Whether it is pure proxy. ,
Required: False ,
}
boolean ,
identityManagement:
{
Description: The identity management. ,
Required: False ,
}
string ,
checkNameAvailabilitySpecifications:
{
Description: The check name availability specifications. ,
Required: False ,
}
string ,
disallowedActionVerbs:
{
Description: The disallowed action verbs. ,
Required: False ,
}
[
string ,
]
,
serviceTreeInfos:
{
Description: The service tree infos. ,
Required: False ,
}
[
{
serviceId:
{
Description: The service id. ,
Required: False ,
}
string ,
componentId:
{
Description: The component id. ,
Required: False ,
}
string ,
readiness:
{
Description: The readiness. ,
Enum:
{
ClosingDown: No description available. ,
Deprecated: No description available. ,
GA: No description available. ,
InDevelopment: No description available. ,
InternalOnly: No description available. ,
PrivatePreview: No description available. ,
PublicPreview: No description available. ,
RemovedFromARM: No description available. ,
Retired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
requestHeaderOptions:
{
Description: The request header options. ,
Required: False ,
}
string ,
subscriptionStateRules:
{
Description: The subscription state rules. ,
Required: False ,
}
[
{
state:
{
Description: The subscription state. ,
Enum:
{
NotDefined: No description available. ,
Enabled: No description available. ,
Warned: No description available. ,
PastDue: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
allowedActions:
{
Description: The allowed actions. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
templateDeploymentOptions:
{
Description: The template deployment options. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations. ,
Required: False ,
}
[
{
type:
{
Description: The type. ,
Enum:
{
NotSpecified: The extended location type is not specified. ,
CustomLocation: The extended location type is custom location. ,
EdgeZone: The extended location type is edge zone. ,
ArcZone: The extended location type is arc zone. ,
}
,
Required: False ,
}
enum ,
supportedPolicy:
{
Enum:
{
NotSpecified: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resourceMovePolicy:
{
Description: The resource move policy. ,
Required: False ,
}
string ,
resourceDeletionPolicy:
{
Description: The resource deletion policy. ,
Enum:
{
NotSpecified: No description available. ,
CascadeDeleteAll: No description available. ,
CascadeDeleteProxyOnlyChildren: No description available. ,
}
,
Required: False ,
}
enum ,
resourceConcurrencyControlOptions:
{
Description: The resource concurrency control options. ,
Required: False ,
}
object ,
resourceGraphConfiguration:
{
Description: The resource graph configuration. ,
Required: False ,
}
string ,
management:
{
Description: The resource provider management. ,
Required: False ,
}
string ,
openApiConfiguration:
{
Description: The open api configuration. ,
Required: False ,
}
{
validation:
{
Description: The open api validation. ,
Required: False ,
}
{
allowNoncompliantCollectionResponse:
{
Description: Indicates whether a non compliance response is allowed for a LIST call ,
Required: False ,
}
boolean ,
}
,
}
,
onBehalfOfTokens:
{
Description: The on behalf of tokens. ,
Required: False ,
}
{
actionName:
{
Description: The action name. ,
Required: False ,
}
string ,
lifeTime:
{
Description: This is a TimeSpan property. ,
Required: False ,
}
string ,
}
,
category:
{
Description: The category. ,
Enum:
{
None: No description available. ,
FreeForm: No description available. ,
Internal: No description available. ,
PureProxy: No description available. ,
}
,
Required: False ,
}
enum ,
resourceValidation:
{
Description: The resource validation. ,
Enum:
{
NotSpecified: No description available. ,
ReservedWords: No description available. ,
ProfaneWords: No description available. ,
}
,
Required: False ,
}
enum ,
disallowedEndUserOperations:
{
Description: The disallowed end user operations. ,
Required: False ,
}
[
string ,
]
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
skuLink:
{
Description: The sku link. ,
Required: False ,
}
string ,
quotaRule:
{
Description: The quota rule. ,
Required: False ,
}
{
quotaPolicy:
{
Description: The quota policy. ,
Enum:
{
Default: No description available. ,
None: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
locationRules:
{
Description: The location rules. ,
Required: False ,
}
[
{
policy:
{
Description: The policy. ,
Enum:
{
Default: No description available. ,
None: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
quotaId:
{
Description: The quota id. ,
Required: False ,
}
string ,
location:
{
Description: The location. ,
Required: False ,
}
string ,
}
,
]
,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
}
,
notifications:
{
Description: The notifications. ,
Required: False ,
}
[
{
notificationType:
{
Description: The notification type. ,
Enum:
{
Unspecified: No description available. ,
SubscriptionNotification: No description available. ,
}
,
Required: False ,
}
enum ,
skipNotifications:
{
Description: Whether notifications should be skipped. ,
Enum:
{
Unspecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
linkedNotificationRules:
{
Description: The linked notification rules. ,
Required: False ,
}
[
{
actions:
{
Description: The actions. ,
Required: False ,
}
[
string ,
]
,
actionsOnFailedOperation:
{
Description: The actions on failed operation. ,
Required: False ,
}
[
string ,
]
,
fastPathActions:
{
Description: The fast path actions. ,
Required: False ,
}
[
string ,
]
,
fastPathActionsOnFailedOperation:
{
Description: The fast path action on failed operation. ,
Required: False ,
}
[
string ,
]
,
linkedNotificationTimeout:
{
Description: This is a TimeSpan property. ,
Format: duration ,
Required: False ,
}
string ,
}
,
]
,
resourceProviderAuthorizationRules:
{
Description: The resource provider authorization rules. ,
Required: False ,
}
{
asyncOperationPollingRules:
{
Description: The async operation polling rules. ,
Required: False ,
}
{
authorizationActions:
{
Description: The authorization actions. ,
Required: False ,
}
[
string ,
]
,
additionalOptions:
{
Description: The additional options. ,
Enum:
{
ProtectedAsyncOperationPolling: No description available. ,
ProtectedAsyncOperationPollingAuditOnly: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
tokenAuthConfiguration:
{
Description: The token auth configuration. ,
Required: False ,
}
{
authenticationScheme:
{
Description: The authentication scheme. ,
Enum:
{
PoP: No description available. ,
Bearer: No description available. ,
}
,
Required: False ,
}
enum ,
signedRequestScope:
{
Description: The signed request scope. ,
Enum:
{
ResourceUri: No description available. ,
Endpoint: No description available. ,
}
,
Required: False ,
}
enum ,
disableCertificateAuthenticationFallback:
{
Description: Whether certification authentication fallback is disabled. ,
Required: False ,
}
boolean ,
}
,
templateDeploymentPolicy:
{
Description: The template deployment policy. ,
Required: False ,
}
string ,
allowEmptyRoleAssignments:
{
Description: The allow empty role assignments. ,
Required: False ,
}
boolean ,
policyExecutionType:
{
Description: The policy execution type. ,
Enum:
{
NotSpecified: No description available. ,
ExecutePolicies: No description available. ,
BypassPolicies: No description available. ,
ExpectPartialPutRequests: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityZoneRule:
{
Description: The availability zone rule. ,
Required: False ,
}
{
availabilityZonePolicy:
{
Enum:
{
NotSpecified: No description available. ,
SingleZoned: No description available. ,
MultiZoned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dstsConfiguration:
{
Description: The dsts configuration. ,
Required: False ,
}
string ,
asyncTimeoutRules:
{
Description: Async timeout rules ,
Required: False ,
}
[
{
actionName:
{
Required: False ,
}
string ,
timeout:
{
Description: This is a TimeSpan property ,
Required: False ,
}
string ,
}
,
]
,
commonApiVersions:
{
Description: Common API versions for the resource type. ,
Required: False ,
}
[
string ,
]
,
apiProfiles:
{
Description: The api profiles. ,
Required: False ,
}
[
{
profileVersion:
{
Description: Profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: Api version. ,
Required: False ,
}
string ,
}
,
]
,
linkedOperationRules:
{
Description: The linked operation rules. ,
Required: False ,
}
[
{
linkedOperation:
{
Description: The linked operation. ,
Enum:
{
None: No description available. ,
CrossResourceGroupResourceMove: No description available. ,
CrossSubscriptionResourceMove: No description available. ,
}
,
Required: True ,
}
enum ,
linkedAction:
{
Description: The linked action. ,
Enum:
{
NotSpecified: No description available. ,
Blocked: No description available. ,
Validate: No description available. ,
Enabled: No description available. ,
}
,
Required: True ,
}
enum ,
dependsOnTypes:
{
Description: Depends on types. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
legacyName:
{
Description: The legacy name. ,
Required: False ,
}
string ,
legacyNames:
{
Description: The legacy names. ,
Required: False ,
}
[
string ,
]
,
allowedTemplateDeploymentReferenceActions:
{
Description: Allowed template deployment reference actions. ,
Required: False ,
}
[
string ,
]
,
legacyPolicy:
{
Description: The legacy policy. ,
Required: False ,
}
{
disallowedLegacyOperations:
{
Required: False ,
}
[
string ,
]
,
disallowedConditions:
{
Required: False ,
}
[
{
disallowedLegacyOperations:
{
Description: The disallowed legacy operations. ,
Required: False ,
}
[
string ,
]
,
feature:
{
Description: Feature string. ,
Required: False ,
}
string ,
}
,
]
,
}
,
manifestLink:
{
Description: Manifest link. ,
Required: False ,
}
string ,
capacityRule:
{
Description: Capacity rule. ,
Required: False ,
}
{
capacityPolicy:
{
Description: Capacity policy. ,
Enum:
{
Default: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
skuAlias:
{
Description: Sku alias ,
Required: False ,
}
string ,
}
,
marketplaceOptions:
{
Description: Marketplace options. ,
Required: False ,
}
{
addOnPlanConversionAllowed:
{
Description: Add-on plan conversion allowed. ,
Required: False ,
}
boolean ,
}
,
allowedResourceNames:
{
Description: The allowed resource names. ,
Required: False ,
}
[
{
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
getActionVerb:
{
Description: Get action verb. ,
Required: False ,
}
string ,
}
,
]
,
resourceCache:
{
Description: Resource cache options. ,
Required: False ,
}
{
enableResourceCache:
{
Description: Enable resource cache. ,
Required: False ,
}
boolean ,
resourceCacheExpirationTimespan:
{
Description: Resource cache expiration timespan. This is a TimeSpan property. ,
Required: False ,
}
string ,
}
,
resourceQueryManagement:
{
Description: Resource query management options. ,
Required: False ,
}
{
filterOption:
{
Description: Filter option. ,
Enum:
{
NotSpecified: No description available. ,
EnableSubscriptionFilterOnTenant: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
supportsTags:
{
Description: Whether tags are supported. ,
Required: False ,
}
boolean ,
resourceManagementOptions:
{
Description: Resource management options. ,
Required: False ,
}
{
batchProvisioningSupport:
{
Description: Batch provisioning support. ,
Required: False ,
}
{
supportedOperations:
{
Description: Supported operations. ,
Enum:
{
NotSpecified: No description available. ,
Get: No description available. ,
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
deleteDependencies:
{
Description: Delete dependencies. ,
Required: False ,
}
[
{
requiredFeatures:
{
Description: Required features. ,
Required: False ,
}
[
string ,
]
,
linkedProperty:
{
Description: Linked property. ,
Required: False ,
}
string ,
linkedType:
{
Description: Linked type. ,
Required: False ,
}
string ,
}
,
]
,
nestedProvisioningSupport:
{
Description: Nested provisioning support. ,
Required: False ,
}
{
minimumApiVersion:
{
Description: Minimum API version. ,
Required: False ,
}
string ,
}
,
}
,
groupingTag:
{
Description: Grouping tag. ,
Required: False ,
}
string ,
addResourceListTargetLocations:
{
Description: Add resource list target locations? ,
Required: False ,
}
boolean ,
resourceTypeCommonAttributeManagement:
{
Description: Resource type common attribute management. ,
Required: False ,
}
{
commonApiVersionsMergeMode:
{
Description: Common api versions merge mode. ,
Enum:
{
Merge: No description available. ,
Overwrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
routingRule:
{
Description: Routing rule. ,
Required: False ,
}
{
hostResourceType:
{
Description: Hosted resource type. ,
Required: False ,
}
string ,
}
,
frontdoorRequestMode:
{
Description: The frontdoor request mode. ,
Enum:
{
NotSpecified: No description available. ,
UseManifest: No description available. ,
}
,
Required: False ,
}
enum ,
resourceSubType:
{
Description: The resource sub type. ,
Enum:
{
NotSpecified: No description available. ,
AsyncOperation: No description available. ,
}
,
Required: False ,
}
enum ,
asyncOperationResourceTypeName:
{
Description: The async operation resource type name. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
kind:
{
Description: Resource type registration kind. This Metadata is also used by portal/tooling/etc to render different UX experiences for resources of the same type. ,
Enum:
{
Managed: Resource type served by the ProviderHub service. ,
Hybrid: Resource type served by both the ProviderHub & the onboarded Resource Provider Services (i.e. The type has a mix of managed and direct endpoints). ,
Direct: Resource type served by the onboarded Resource Provider Service. ,
}
,
Required: False ,
}
enum ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ResourceTypeRegistrations_Delete (new)
Description :  Deletes a resource type
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourcetypeRegistrations/{resourceType}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ResourceTypeRegistrations_ListByProviderRegistration (new)
Description :  Gets the list of the resource types for the given provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourcetypeRegistrations
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
routingType:
{
Description: The resource routing type. ,
Enum:
{
Default: The resource routing type is default. ,
ProxyOnly: The resource routing type is proxy only. ,
HostBased: The resource routing type is host based. ,
Extension: The resource routing type is extension. ,
Tenant: The resource routing type is tenant. ,
Fanout: The resource routing type is fanout. ,
LocationBased: The resource routing type is location based. ,
Failover: The resource routing type is failover. ,
CascadeExtension: The resource routing type is cascade extension. ,
ChildFanout: The resource routing type is child fanout. ,
CascadeAuthorizedExtension: The resource routing type is cascade authorized extension. ,
BypassEndpointSelectionOptimization: The resource routing type is bypass endpoint selection optimization. ,
LocationMapping: The resource routing type is location mapping. ,
ServiceFanout: The resource routing type is service fanout. ,
}
,
Required: False ,
}
enum ,
additionalOptions:
{
Description: The additional options. ,
Enum:
{
ProtectedAsyncOperationPolling: No description available. ,
ProtectedAsyncOperationPollingAuditOnly: No description available. ,
}
,
Required: False ,
}
enum ,
crossTenantTokenValidation:
{
Description: The cross tenant token validation. ,
Enum:
{
EnsureSecureValidation: No description available. ,
PassthroughInsecureToken: No description available. ,
}
,
Required: False ,
}
enum ,
regionality:
{
Description: The regionality. ,
Enum:
{
NotSpecified: No description available. ,
Global: No description available. ,
Regional: No description available. ,
}
,
Required: False ,
}
enum ,
endpoints:
{
Description: The extensions. ,
Required: False ,
}
[
{
kind:
{
Description: Resource type endpoint kind. This Metadata is also used by portal/tooling/etc to render different UX experiences for resources of the same type. ,
Enum:
{
Managed: Endpoint served by ProviderHub service ,
Direct: Endpoint served by the onboarded Resource Provider Service. ,
}
,
Required: False ,
}
enum ,
enabled:
{
Description: Whether the endpoint is enabled. ,
Required: False ,
}
boolean ,
apiVersions:
{
Description: The api versions. ,
Required: False ,
}
[
string ,
]
,
locations:
{
Description: The locations. ,
Required: False ,
}
[
string ,
]
,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
featuresRule:
{
Description: The features rule. ,
Required: False ,
}
string ,
extensions:
{
Description: The extensions. ,
Required: False ,
}
[
{
endpointUri:
{
Description: The endpoint uri. ,
Required: False ,
}
string ,
extensionCategories:
{
Description: The extension categories. ,
Required: False ,
}
[
string ,
]
,
timeout:
{
Description: The timeout. ,
Format: duration ,
Required: False ,
}
string ,
}
,
]
,
timeout:
{
Description: The timeout. ,
Format: duration ,
Required: False ,
}
string ,
endpointType:
{
Description: The endpoint type. ,
Enum:
{
NotSpecified: No description available. ,
Canary: No description available. ,
Production: No description available. ,
TestInProduction: No description available. ,
}
,
Required: False ,
}
enum ,
tokenAuthConfiguration:
{
Description: The token auth configuration. ,
Required: False ,
}
{
authenticationScheme:
{
Description: The authentication scheme. ,
Enum:
{
PoP: No description available. ,
Bearer: No description available. ,
}
,
Required: False ,
}
enum ,
signedRequestScope:
{
Description: The signed request scope. ,
Enum:
{
ResourceUri: No description available. ,
Endpoint: No description available. ,
}
,
Required: False ,
}
enum ,
disableCertificateAuthenticationFallback:
{
Description: Whether certification authentication fallback is disabled. ,
Required: False ,
}
boolean ,
}
,
skuLink:
{
Description: The sku link. ,
Required: False ,
}
string ,
endpointUri:
{
Description: The endpoint uri. ,
Required: False ,
}
string ,
apiVersion:
{
Description: Api version. ,
Required: False ,
}
string ,
zones:
{
Description: List of zones. ,
Required: False ,
}
[
string ,
]
,
dstsConfiguration:
{
Description: The dsts configuration. ,
Required: False ,
}
string ,
dataBoundary:
{
Description: The data boundary. ,
Enum:
{
NotDefined: No description available. ,
Global: No description available. ,
EU: No description available. ,
US: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
extensionOptions:
{
Description: The extension options. ,
Required: False ,
}
string ,
marketplaceType:
{
Description: The marketplace type. ,
Enum:
{
NotSpecified: No description available. ,
AddOn: No description available. ,
Bypass: No description available. ,
Store: No description available. ,
}
,
Required: False ,
}
enum ,
swaggerSpecifications:
{
Description: The swagger specifications. ,
Required: False ,
}
[
{
apiVersions:
{
Description: The api versions. ,
Required: False ,
}
[
string ,
]
,
swaggerSpecFolderUri:
{
Description: The swagger spec folder uri. ,
Required: False ,
}
string ,
}
,
]
,
allowedUnauthorizedActions:
{
Description: The allowed unauthorized actions. ,
Required: False ,
}
[
string ,
]
,
allowedUnauthorizedActionsExtensions:
{
Description: The allowed unauthorized actions extensions. ,
Required: False ,
}
[
{
action:
{
Description: The action. ,
Required: False ,
}
string ,
intent:
{
Description: The intent. ,
Enum:
{
NOT_SPECIFIED: Default value. ,
LOW_PRIVILEGE: Data is not sensitive and ok to access. ,
DEFERRED_ACCESS_CHECK: Used for RP's using a custom authorization check outside of ARM. ,
RP_CONTRACT: RP contract allows certain operations to be unauthorized action. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
authorizationActionMappings:
{
Description: The authorization action mappings ,
Required: False ,
}
[
{
original:
{
Description: The original action name. ,
Required: False ,
}
string ,
desired:
{
Description: The desired action name. ,
Required: False ,
}
string ,
}
,
]
,
linkedAccessChecks:
{
Description: The linked access checks. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: False ,
}
string ,
linkedProperty:
{
Description: The linked property. ,
Required: False ,
}
string ,
linkedAction:
{
Description: The linked action. ,
Required: False ,
}
string ,
linkedActionVerb:
{
Description: The linked action verb. ,
Required: False ,
}
string ,
linkedType:
{
Description: The linked type. ,
Required: False ,
}
string ,
}
,
]
,
defaultApiVersion:
{
Description: The default api version. ,
Required: False ,
}
string ,
loggingRules:
{
Description: The logging rules. ,
Required: False ,
}
[
{
action:
{
Description: The action. ,
Required: True ,
}
string ,
direction:
{
Description: The direction. ,
Enum:
{
None: No description available. ,
Request: No description available. ,
Response: No description available. ,
}
,
Required: True ,
}
enum ,
detailLevel:
{
Description: The detail level. ,
Enum:
{
None: No description available. ,
Body: No description available. ,
}
,
Required: True ,
}
enum ,
hiddenPropertyPaths:
{
Description: The hidden property paths. ,
Required: False ,
}
string ,
}
,
]
,
throttlingRules:
{
Description: The throttling rules. ,
Required: False ,
}
[
{
action:
{
Description: The action. ,
Required: True ,
}
string ,
metrics:
{
Description: The metrics. ,
Required: True ,
}
[
{
type:
{
Description: The throttling metric type ,
Enum:
{
NotSpecified: No description available. ,
NumberOfRequests: No description available. ,
NumberOfResources: No description available. ,
}
,
Required: True ,
}
enum ,
limit:
{
Description: The limit. ,
Format: int64 ,
Required: True ,
}
integer ,
interval:
{
Description: The interval. ,
Format: duration ,
Required: False ,
}
string ,
}
,
]
,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
applicationId:
{
Description: The application id. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
featuresRule:
{
Description: The features rule. ,
Required: False ,
}
string ,
enableAsyncOperation:
{
Description: Whether async operation is enabled. ,
Required: False ,
}
boolean ,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
enableThirdPartyS2S:
{
Description: Whether third party S2S is enabled. ,
Required: False ,
}
boolean ,
subscriptionLifecycleNotificationSpecifications:
{
Description: The subscription lifecycle notification specifications. ,
Required: False ,
}
string ,
isPureProxy:
{
Description: Whether it is pure proxy. ,
Required: False ,
}
boolean ,
identityManagement:
{
Description: The identity management. ,
Required: False ,
}
string ,
checkNameAvailabilitySpecifications:
{
Description: The check name availability specifications. ,
Required: False ,
}
string ,
disallowedActionVerbs:
{
Description: The disallowed action verbs. ,
Required: False ,
}
[
string ,
]
,
serviceTreeInfos:
{
Description: The service tree infos. ,
Required: False ,
}
[
{
serviceId:
{
Description: The service id. ,
Required: False ,
}
string ,
componentId:
{
Description: The component id. ,
Required: False ,
}
string ,
readiness:
{
Description: The readiness. ,
Enum:
{
ClosingDown: No description available. ,
Deprecated: No description available. ,
GA: No description available. ,
InDevelopment: No description available. ,
InternalOnly: No description available. ,
PrivatePreview: No description available. ,
PublicPreview: No description available. ,
RemovedFromARM: No description available. ,
Retired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
requestHeaderOptions:
{
Description: The request header options. ,
Required: False ,
}
string ,
subscriptionStateRules:
{
Description: The subscription state rules. ,
Required: False ,
}
[
{
state:
{
Description: The subscription state. ,
Enum:
{
NotDefined: No description available. ,
Enabled: No description available. ,
Warned: No description available. ,
PastDue: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
allowedActions:
{
Description: The allowed actions. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
templateDeploymentOptions:
{
Description: The template deployment options. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations. ,
Required: False ,
}
[
{
type:
{
Description: The type. ,
Enum:
{
NotSpecified: The extended location type is not specified. ,
CustomLocation: The extended location type is custom location. ,
EdgeZone: The extended location type is edge zone. ,
ArcZone: The extended location type is arc zone. ,
}
,
Required: False ,
}
enum ,
supportedPolicy:
{
Enum:
{
NotSpecified: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
resourceMovePolicy:
{
Description: The resource move policy. ,
Required: False ,
}
string ,
resourceDeletionPolicy:
{
Description: The resource deletion policy. ,
Enum:
{
NotSpecified: No description available. ,
CascadeDeleteAll: No description available. ,
CascadeDeleteProxyOnlyChildren: No description available. ,
}
,
Required: False ,
}
enum ,
resourceConcurrencyControlOptions:
{
Description: The resource concurrency control options. ,
Required: False ,
}
object ,
resourceGraphConfiguration:
{
Description: The resource graph configuration. ,
Required: False ,
}
string ,
management:
{
Description: The resource provider management. ,
Required: False ,
}
string ,
openApiConfiguration:
{
Description: The open api configuration. ,
Required: False ,
}
{
validation:
{
Description: The open api validation. ,
Required: False ,
}
{
allowNoncompliantCollectionResponse:
{
Description: Indicates whether a non compliance response is allowed for a LIST call ,
Required: False ,
}
boolean ,
}
,
}
,
onBehalfOfTokens:
{
Description: The on behalf of tokens. ,
Required: False ,
}
{
actionName:
{
Description: The action name. ,
Required: False ,
}
string ,
lifeTime:
{
Description: This is a TimeSpan property. ,
Required: False ,
}
string ,
}
,
category:
{
Description: The category. ,
Enum:
{
None: No description available. ,
FreeForm: No description available. ,
Internal: No description available. ,
PureProxy: No description available. ,
}
,
Required: False ,
}
enum ,
resourceValidation:
{
Description: The resource validation. ,
Enum:
{
NotSpecified: No description available. ,
ReservedWords: No description available. ,
ProfaneWords: No description available. ,
}
,
Required: False ,
}
enum ,
disallowedEndUserOperations:
{
Description: The disallowed end user operations. ,
Required: False ,
}
[
string ,
]
,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
skuLink:
{
Description: The sku link. ,
Required: False ,
}
string ,
quotaRule:
{
Description: The quota rule. ,
Required: False ,
}
{
quotaPolicy:
{
Description: The quota policy. ,
Enum:
{
Default: No description available. ,
None: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
locationRules:
{
Description: The location rules. ,
Required: False ,
}
[
{
policy:
{
Description: The policy. ,
Enum:
{
Default: No description available. ,
None: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
quotaId:
{
Description: The quota id. ,
Required: False ,
}
string ,
location:
{
Description: The location. ,
Required: False ,
}
string ,
}
,
]
,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
}
,
notifications:
{
Description: The notifications. ,
Required: False ,
}
[
{
notificationType:
{
Description: The notification type. ,
Enum:
{
Unspecified: No description available. ,
SubscriptionNotification: No description available. ,
}
,
Required: False ,
}
enum ,
skipNotifications:
{
Description: Whether notifications should be skipped. ,
Enum:
{
Unspecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
linkedNotificationRules:
{
Description: The linked notification rules. ,
Required: False ,
}
[
{
actions:
{
Description: The actions. ,
Required: False ,
}
[
string ,
]
,
actionsOnFailedOperation:
{
Description: The actions on failed operation. ,
Required: False ,
}
[
string ,
]
,
fastPathActions:
{
Description: The fast path actions. ,
Required: False ,
}
[
string ,
]
,
fastPathActionsOnFailedOperation:
{
Description: The fast path action on failed operation. ,
Required: False ,
}
[
string ,
]
,
linkedNotificationTimeout:
{
Description: This is a TimeSpan property. ,
Format: duration ,
Required: False ,
}
string ,
}
,
]
,
resourceProviderAuthorizationRules:
{
Description: The resource provider authorization rules. ,
Required: False ,
}
{
asyncOperationPollingRules:
{
Description: The async operation polling rules. ,
Required: False ,
}
{
authorizationActions:
{
Description: The authorization actions. ,
Required: False ,
}
[
string ,
]
,
additionalOptions:
{
Description: The additional options. ,
Enum:
{
ProtectedAsyncOperationPolling: No description available. ,
ProtectedAsyncOperationPollingAuditOnly: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
tokenAuthConfiguration:
{
Description: The token auth configuration. ,
Required: False ,
}
{
authenticationScheme:
{
Description: The authentication scheme. ,
Enum:
{
PoP: No description available. ,
Bearer: No description available. ,
}
,
Required: False ,
}
enum ,
signedRequestScope:
{
Description: The signed request scope. ,
Enum:
{
ResourceUri: No description available. ,
Endpoint: No description available. ,
}
,
Required: False ,
}
enum ,
disableCertificateAuthenticationFallback:
{
Description: Whether certification authentication fallback is disabled. ,
Required: False ,
}
boolean ,
}
,
templateDeploymentPolicy:
{
Description: The template deployment policy. ,
Required: False ,
}
string ,
allowEmptyRoleAssignments:
{
Description: The allow empty role assignments. ,
Required: False ,
}
boolean ,
policyExecutionType:
{
Description: The policy execution type. ,
Enum:
{
NotSpecified: No description available. ,
ExecutePolicies: No description available. ,
BypassPolicies: No description available. ,
ExpectPartialPutRequests: No description available. ,
}
,
Required: False ,
}
enum ,
availabilityZoneRule:
{
Description: The availability zone rule. ,
Required: False ,
}
{
availabilityZonePolicy:
{
Enum:
{
NotSpecified: No description available. ,
SingleZoned: No description available. ,
MultiZoned: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
dstsConfiguration:
{
Description: The dsts configuration. ,
Required: False ,
}
string ,
asyncTimeoutRules:
{
Description: Async timeout rules ,
Required: False ,
}
[
{
actionName:
{
Required: False ,
}
string ,
timeout:
{
Description: This is a TimeSpan property ,
Required: False ,
}
string ,
}
,
]
,
commonApiVersions:
{
Description: Common API versions for the resource type. ,
Required: False ,
}
[
string ,
]
,
apiProfiles:
{
Description: The api profiles. ,
Required: False ,
}
[
{
profileVersion:
{
Description: Profile version. ,
Required: False ,
}
string ,
apiVersion:
{
Description: Api version. ,
Required: False ,
}
string ,
}
,
]
,
linkedOperationRules:
{
Description: The linked operation rules. ,
Required: False ,
}
[
{
linkedOperation:
{
Description: The linked operation. ,
Enum:
{
None: No description available. ,
CrossResourceGroupResourceMove: No description available. ,
CrossSubscriptionResourceMove: No description available. ,
}
,
Required: True ,
}
enum ,
linkedAction:
{
Description: The linked action. ,
Enum:
{
NotSpecified: No description available. ,
Blocked: No description available. ,
Validate: No description available. ,
Enabled: No description available. ,
}
,
Required: True ,
}
enum ,
dependsOnTypes:
{
Description: Depends on types. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
legacyName:
{
Description: The legacy name. ,
Required: False ,
}
string ,
legacyNames:
{
Description: The legacy names. ,
Required: False ,
}
[
string ,
]
,
allowedTemplateDeploymentReferenceActions:
{
Description: Allowed template deployment reference actions. ,
Required: False ,
}
[
string ,
]
,
legacyPolicy:
{
Description: The legacy policy. ,
Required: False ,
}
{
disallowedLegacyOperations:
{
Required: False ,
}
[
string ,
]
,
disallowedConditions:
{
Required: False ,
}
[
{
disallowedLegacyOperations:
{
Description: The disallowed legacy operations. ,
Required: False ,
}
[
string ,
]
,
feature:
{
Description: Feature string. ,
Required: False ,
}
string ,
}
,
]
,
}
,
manifestLink:
{
Description: Manifest link. ,
Required: False ,
}
string ,
capacityRule:
{
Description: Capacity rule. ,
Required: False ,
}
{
capacityPolicy:
{
Description: Capacity policy. ,
Enum:
{
Default: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
skuAlias:
{
Description: Sku alias ,
Required: False ,
}
string ,
}
,
marketplaceOptions:
{
Description: Marketplace options. ,
Required: False ,
}
{
addOnPlanConversionAllowed:
{
Description: Add-on plan conversion allowed. ,
Required: False ,
}
boolean ,
}
,
allowedResourceNames:
{
Description: The allowed resource names. ,
Required: False ,
}
[
{
name:
{
Description: Resource name. ,
Required: False ,
}
string ,
getActionVerb:
{
Description: Get action verb. ,
Required: False ,
}
string ,
}
,
]
,
resourceCache:
{
Description: Resource cache options. ,
Required: False ,
}
{
enableResourceCache:
{
Description: Enable resource cache. ,
Required: False ,
}
boolean ,
resourceCacheExpirationTimespan:
{
Description: Resource cache expiration timespan. This is a TimeSpan property. ,
Required: False ,
}
string ,
}
,
resourceQueryManagement:
{
Description: Resource query management options. ,
Required: False ,
}
{
filterOption:
{
Description: Filter option. ,
Enum:
{
NotSpecified: No description available. ,
EnableSubscriptionFilterOnTenant: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
supportsTags:
{
Description: Whether tags are supported. ,
Required: False ,
}
boolean ,
resourceManagementOptions:
{
Description: Resource management options. ,
Required: False ,
}
{
batchProvisioningSupport:
{
Description: Batch provisioning support. ,
Required: False ,
}
{
supportedOperations:
{
Description: Supported operations. ,
Enum:
{
NotSpecified: No description available. ,
Get: No description available. ,
Delete: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
deleteDependencies:
{
Description: Delete dependencies. ,
Required: False ,
}
[
{
requiredFeatures:
{
Description: Required features. ,
Required: False ,
}
[
string ,
]
,
linkedProperty:
{
Description: Linked property. ,
Required: False ,
}
string ,
linkedType:
{
Description: Linked type. ,
Required: False ,
}
string ,
}
,
]
,
nestedProvisioningSupport:
{
Description: Nested provisioning support. ,
Required: False ,
}
{
minimumApiVersion:
{
Description: Minimum API version. ,
Required: False ,
}
string ,
}
,
}
,
groupingTag:
{
Description: Grouping tag. ,
Required: False ,
}
string ,
addResourceListTargetLocations:
{
Description: Add resource list target locations? ,
Required: False ,
}
boolean ,
resourceTypeCommonAttributeManagement:
{
Description: Resource type common attribute management. ,
Required: False ,
}
{
commonApiVersionsMergeMode:
{
Description: Common api versions merge mode. ,
Enum:
{
Merge: No description available. ,
Overwrite: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
routingRule:
{
Description: Routing rule. ,
Required: False ,
}
{
hostResourceType:
{
Description: Hosted resource type. ,
Required: False ,
}
string ,
}
,
frontdoorRequestMode:
{
Description: The frontdoor request mode. ,
Enum:
{
NotSpecified: No description available. ,
UseManifest: No description available. ,
}
,
Required: False ,
}
enum ,
resourceSubType:
{
Description: The resource sub type. ,
Enum:
{
NotSpecified: No description available. ,
AsyncOperation: No description available. ,
}
,
Required: False ,
}
enum ,
asyncOperationResourceTypeName:
{
Description: The async operation resource type name. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
kind:
{
Description: Resource type registration kind. This Metadata is also used by portal/tooling/etc to render different UX experiences for resources of the same type. ,
Enum:
{
Managed: Resource type served by the ProviderHub service. ,
Hybrid: Resource type served by both the ProviderHub & the onboarded Resource Provider Services (i.e. The type has a mix of managed and direct endpoints). ,
Direct: Resource type served by the onboarded Resource Provider Service. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
nextLink:
{
Description: The URL to get to the next set of results, if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Skus_Get (new)
Description :  Gets the sku details for the given resource type and sku name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourcetypeRegistrations/{resourceType}/skus/{sku}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type. ,
Required: True ,
}
string ,
sku:
{
Description: The SKU. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Skus_CreateOrUpdate (new)
Description :  Creates or updates the resource type skus in the given resource type.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourcetypeRegistrations/{resourceType}/skus/{sku}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type. ,
Required: True ,
}
string ,
sku:
{
Description: The SKU. ,
Required: True ,
}
string ,
properties:
{
Description: The required body parameters supplied to the resource sku operation. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Skus_Delete (new)
Description :  Deletes a resource type sku.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourcetypeRegistrations/{resourceType}/skus/{sku}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type. ,
Required: True ,
}
string ,
sku:
{
Description: The SKU. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Skus_GetNestedResourceTypeFirst (new)
Description :  Gets the sku details for the given resource type and sku name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourcetypeRegistrations/{resourceType}/resourcetypeRegistrations/{nestedResourceTypeFirst}/skus/{sku}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type. ,
Required: True ,
}
string ,
nestedResourceTypeFirst:
{
Description: The first child resource type. ,
Required: True ,
}
string ,
sku:
{
Description: The SKU. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Skus_CreateOrUpdateNestedResourceTypeFirst (new)
Description :  Creates or updates the resource type skus in the given resource type.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourcetypeRegistrations/{resourceType}/resourcetypeRegistrations/{nestedResourceTypeFirst}/skus/{sku}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type. ,
Required: True ,
}
string ,
nestedResourceTypeFirst:
{
Description: The first child resource type. ,
Required: True ,
}
string ,
sku:
{
Description: The SKU. ,
Required: True ,
}
string ,
properties:
{
Description: The required body parameters supplied to the resource sku operation. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Skus_DeleteNestedResourceTypeFirst (new)
Description :  Deletes a resource type sku.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourcetypeRegistrations/{resourceType}/resourcetypeRegistrations/{nestedResourceTypeFirst}/skus/{sku}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type. ,
Required: True ,
}
string ,
nestedResourceTypeFirst:
{
Description: The first child resource type. ,
Required: True ,
}
string ,
sku:
{
Description: The SKU. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Skus_GetNestedResourceTypeSecond (new)
Description :  Gets the sku details for the given resource type and sku name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourcetypeRegistrations/{resourceType}/resourcetypeRegistrations/{nestedResourceTypeFirst}/resourcetypeRegistrations/{nestedResourceTypeSecond}/skus/{sku}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type. ,
Required: True ,
}
string ,
nestedResourceTypeFirst:
{
Description: The first child resource type. ,
Required: True ,
}
string ,
nestedResourceTypeSecond:
{
Description: The second child resource type. ,
Required: True ,
}
string ,
sku:
{
Description: The SKU. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Skus_CreateOrUpdateNestedResourceTypeSecond (new)
Description :  Creates or updates the resource type skus in the given resource type.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourcetypeRegistrations/{resourceType}/resourcetypeRegistrations/{nestedResourceTypeFirst}/resourcetypeRegistrations/{nestedResourceTypeSecond}/skus/{sku}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type. ,
Required: True ,
}
string ,
nestedResourceTypeFirst:
{
Description: The first child resource type. ,
Required: True ,
}
string ,
nestedResourceTypeSecond:
{
Description: The second child resource type. ,
Required: True ,
}
string ,
sku:
{
Description: The SKU. ,
Required: True ,
}
string ,
properties:
{
Description: The required body parameters supplied to the resource sku operation. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Skus_DeleteNestedResourceTypeSecond (new)
Description :  Deletes a resource type sku.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourcetypeRegistrations/{resourceType}/resourcetypeRegistrations/{nestedResourceTypeFirst}/resourcetypeRegistrations/{nestedResourceTypeSecond}/skus/{sku}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type. ,
Required: True ,
}
string ,
nestedResourceTypeFirst:
{
Description: The first child resource type. ,
Required: True ,
}
string ,
nestedResourceTypeSecond:
{
Description: The second child resource type. ,
Required: True ,
}
string ,
sku:
{
Description: The SKU. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Skus_GetNestedResourceTypeThird (new)
Description :  Gets the sku details for the given resource type and sku name.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourcetypeRegistrations/{resourceType}/resourcetypeRegistrations/{nestedResourceTypeFirst}/resourcetypeRegistrations/{nestedResourceTypeSecond}/resourcetypeRegistrations/{nestedResourceTypeThird}/skus/{sku}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type. ,
Required: True ,
}
string ,
nestedResourceTypeFirst:
{
Description: The first child resource type. ,
Required: True ,
}
string ,
nestedResourceTypeSecond:
{
Description: The second child resource type. ,
Required: True ,
}
string ,
nestedResourceTypeThird:
{
Description: The third child resource type. ,
Required: True ,
}
string ,
sku:
{
Description: The SKU. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Skus_CreateOrUpdateNestedResourceTypeThird (new)
Description :  Creates or updates the resource type skus in the given resource type.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourcetypeRegistrations/{resourceType}/resourcetypeRegistrations/{nestedResourceTypeFirst}/resourcetypeRegistrations/{nestedResourceTypeSecond}/resourcetypeRegistrations/{nestedResourceTypeThird}/skus/{sku}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type. ,
Required: True ,
}
string ,
nestedResourceTypeFirst:
{
Description: The first child resource type. ,
Required: True ,
}
string ,
nestedResourceTypeSecond:
{
Description: The second child resource type. ,
Required: True ,
}
string ,
nestedResourceTypeThird:
{
Description: The third child resource type. ,
Required: True ,
}
string ,
sku:
{
Description: The SKU. ,
Required: True ,
}
string ,
properties:
{
Description: The required body parameters supplied to the resource sku operation. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Skus_DeleteNestedResourceTypeThird (new)
Description :  Deletes a resource type sku.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourcetypeRegistrations/{resourceType}/resourcetypeRegistrations/{nestedResourceTypeFirst}/resourcetypeRegistrations/{nestedResourceTypeSecond}/resourcetypeRegistrations/{nestedResourceTypeThird}/skus/{sku}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type. ,
Required: True ,
}
string ,
nestedResourceTypeFirst:
{
Description: The first child resource type. ,
Required: True ,
}
string ,
nestedResourceTypeSecond:
{
Description: The second child resource type. ,
Required: True ,
}
string ,
nestedResourceTypeThird:
{
Description: The third child resource type. ,
Required: True ,
}
string ,
sku:
{
Description: The SKU. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Skus_ListByResourceTypeRegistrations (new)
Description :  Gets the list of skus for the given resource type.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourcetypeRegistrations/{resourceType}/skus
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The sku resources. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get to the next set of results, if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Skus_ListByResourceTypeRegistrationsNestedResourceTypeFirst (new)
Description :  Gets the list of skus for the given resource type.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourcetypeRegistrations/{resourceType}/resourcetypeRegistrations/{nestedResourceTypeFirst}/skus
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type. ,
Required: True ,
}
string ,
nestedResourceTypeFirst:
{
Description: The first child resource type. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The sku resources. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get to the next set of results, if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Skus_ListByResourceTypeRegistrationsNestedResourceTypeSecond (new)
Description :  Gets the list of skus for the given resource type.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourcetypeRegistrations/{resourceType}/resourcetypeRegistrations/{nestedResourceTypeFirst}/resourcetypeRegistrations/{nestedResourceTypeSecond}/skus
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type. ,
Required: True ,
}
string ,
nestedResourceTypeFirst:
{
Description: The first child resource type. ,
Required: True ,
}
string ,
nestedResourceTypeSecond:
{
Description: The second child resource type. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The sku resources. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get to the next set of results, if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
Skus_ListByResourceTypeRegistrationsNestedResourceTypeThird (new)
Description :  Gets the list of skus for the given resource type.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourcetypeRegistrations/{resourceType}/resourcetypeRegistrations/{nestedResourceTypeFirst}/resourcetypeRegistrations/{nestedResourceTypeSecond}/resourcetypeRegistrations/{nestedResourceTypeThird}/skus
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
resourceType:
{
Description: The resource type. ,
Required: True ,
}
string ,
nestedResourceTypeFirst:
{
Description: The first child resource type. ,
Required: True ,
}
string ,
nestedResourceTypeSecond:
{
Description: The second child resource type. ,
Required: True ,
}
string ,
nestedResourceTypeThird:
{
Description: The third child resource type. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The sku resources. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
string ,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get to the next set of results, if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ResourceActions_DeleteResources (new)
Description :  Deletes resources.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/resourceActions/{resourceActionName}/deleteResources
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
resourceActionName:
{
Description: The resource action name. ,
Required: True ,
}
string ,
properties:
{
Description: The properties supplied to the DeleteResources operation. ,
Required: True ,
}
{
resources:
{
Description: resource management action content. ,
Required: False ,
}
[
{
resourceId:
{
Description: The resource id. ,
Format: arm-id ,
Required: True ,
}
string ,
homeTenantId:
{
Description: The home tenant id. ,
Required: False ,
}
string ,
location:
{
Description: The location. ,
Required: False ,
}
string ,
status:
{
Description: The operation status. ,
Required: False ,
}
string ,
}
,
]
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
location: string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AuthorizedApplications_Get (new)
Description :  Gets the authorized application details.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/authorizedApplications/{applicationId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
applicationId:
{
Description: The application ID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
providerAuthorization:
{
Required: False ,
}
{
roleDefinitionId:
{
Description: The role definition ID for the application. ,
Required: False ,
}
string ,
managedByRoleDefinitionId:
{
Description: The managed by role definition ID for the application. ,
Required: False ,
}
string ,
}
,
dataAuthorizations:
{
Description: The authorizations that determine the level of data access permissions on the specified resource types. ,
Required: False ,
}
[
{
role:
{
Description: The ownership role the application has on the resource types. The service owner role gives the application owner permissions. The limited owner role gives elevated permissions but does not allow all the permissions of a service owner, such as read/write on internal metadata. ,
Enum:
{
ServiceOwner: No description available. ,
LimitedOwner: No description available. ,
}
,
Required: True ,
}
enum ,
resourceTypes:
{
Description: The resource types from the defined resource types in the provider namespace that the application can access. If no resource types are specified and the role is service owner, the default is * which is all resource types ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AuthorizedApplications_CreateOrUpdate (new)
Description :  Creates or updates the authorized application.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/authorizedApplications/{applicationId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
applicationId:
{
Description: The application ID. ,
Format: uuid ,
Required: True ,
}
string ,
properties:
{
Description: The authorized application properties supplied to the CreateOrUpdate operation. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
providerAuthorization:
{
Required: False ,
}
{
roleDefinitionId:
{
Description: The role definition ID for the application. ,
Required: False ,
}
string ,
managedByRoleDefinitionId:
{
Description: The managed by role definition ID for the application. ,
Required: False ,
}
string ,
}
,
dataAuthorizations:
{
Description: The authorizations that determine the level of data access permissions on the specified resource types. ,
Required: False ,
}
[
{
role:
{
Description: The ownership role the application has on the resource types. The service owner role gives the application owner permissions. The limited owner role gives elevated permissions but does not allow all the permissions of a service owner, such as read/write on internal metadata. ,
Enum:
{
ServiceOwner: No description available. ,
LimitedOwner: No description available. ,
}
,
Required: True ,
}
enum ,
resourceTypes:
{
Description: The resource types from the defined resource types in the provider namespace that the application can access. If no resource types are specified and the role is service owner, the default is * which is all resource types ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
providerAuthorization:
{
Required: False ,
}
{
roleDefinitionId:
{
Description: The role definition ID for the application. ,
Required: False ,
}
string ,
managedByRoleDefinitionId:
{
Description: The managed by role definition ID for the application. ,
Required: False ,
}
string ,
}
,
dataAuthorizations:
{
Description: The authorizations that determine the level of data access permissions on the specified resource types. ,
Required: False ,
}
[
{
role:
{
Description: The ownership role the application has on the resource types. The service owner role gives the application owner permissions. The limited owner role gives elevated permissions but does not allow all the permissions of a service owner, such as read/write on internal metadata. ,
Enum:
{
ServiceOwner: No description available. ,
LimitedOwner: No description available. ,
}
,
Required: True ,
}
enum ,
resourceTypes:
{
Description: The resource types from the defined resource types in the provider namespace that the application can access. If no resource types are specified and the role is service owner, the default is * which is all resource types ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
properties:
{
Required: False ,
}
{
providerAuthorization:
{
Required: False ,
}
{
roleDefinitionId:
{
Description: The role definition ID for the application. ,
Required: False ,
}
string ,
managedByRoleDefinitionId:
{
Description: The managed by role definition ID for the application. ,
Required: False ,
}
string ,
}
,
dataAuthorizations:
{
Description: The authorizations that determine the level of data access permissions on the specified resource types. ,
Required: False ,
}
[
{
role:
{
Description: The ownership role the application has on the resource types. The service owner role gives the application owner permissions. The limited owner role gives elevated permissions but does not allow all the permissions of a service owner, such as read/write on internal metadata. ,
Enum:
{
ServiceOwner: No description available. ,
LimitedOwner: No description available. ,
}
,
Required: True ,
}
enum ,
resourceTypes:
{
Description: The resource types from the defined resource types in the provider namespace that the application can access. If no resource types are specified and the role is service owner, the default is * which is all resource types ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AuthorizedApplications_Delete (new)
Description :  Deletes an authorized application.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/authorizedApplications/{applicationId}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
applicationId:
{
Description: The application ID. ,
Format: uuid ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
AuthorizedApplications_List (new)
Description :  Gets the list of the authorized applications in the provider namespace.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/authorizedApplications
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: The value. ,
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
providerAuthorization:
{
Required: False ,
}
{
roleDefinitionId:
{
Description: The role definition ID for the application. ,
Required: False ,
}
string ,
managedByRoleDefinitionId:
{
Description: The managed by role definition ID for the application. ,
Required: False ,
}
string ,
}
,
dataAuthorizations:
{
Description: The authorizations that determine the level of data access permissions on the specified resource types. ,
Required: False ,
}
[
{
role:
{
Description: The ownership role the application has on the resource types. The service owner role gives the application owner permissions. The limited owner role gives elevated permissions but does not allow all the permissions of a service owner, such as read/write on internal metadata. ,
Enum:
{
ServiceOwner: No description available. ,
LimitedOwner: No description available. ,
}
,
Required: True ,
}
enum ,
resourceTypes:
{
Description: The resource types from the defined resource types in the provider namespace that the application can access. If no resource types are specified and the role is service owner, the default is * which is all resource types ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get to the next set of results, if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProviderMonitorSettings_Get (new)
Description :  Gets the provider monitor setting details.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ProviderHub/providerMonitorSettings/{providerMonitorSettingName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
providerMonitorSettingName:
{
Description: The name of the provider monitor setting. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProviderMonitorSettings_Create (new)
Description :  Creates the provider monitor setting.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ProviderHub/providerMonitorSettings/{providerMonitorSettingName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
providerMonitorSettingName:
{
Description: The name of the provider monitor setting. ,
Required: True ,
}
string ,
properties:
{
Description: The provider monitor setting properties supplied to the create operation. ,
Required: True ,
}
{
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProviderMonitorSettings_Update (new)
Description :  Updates the provider monitor setting properties as specified in the request body. Update fails if the specified provider monitor setting does not already exist.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ProviderHub/providerMonitorSettings/{providerMonitorSettingName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
providerMonitorSettingName:
{
Description: The name of the provider monitor setting. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProviderMonitorSettings_Delete (new)
Description :  Deletes a provider monitor setting.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ProviderHub/providerMonitorSettings/{providerMonitorSettingName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
providerMonitorSettingName:
{
Description: The name of the provider monitor setting. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProviderMonitorSettings_ListByResourceGroup (new)
Description :  Gets the list of the provider monitor settings in the resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ProviderHub/providerMonitorSettings
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. The name is case insensitive. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get to the next set of results, if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
ProviderMonitorSettings_ListBySubscription (new)
Description :  Gets the list of the provider monitor settings in the subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerMonitorSettings
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
properties:
{
Required: False ,
}
{
provisioningState:
{
Description: The provisioning state. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}
,
]
,
nextLink:
{
Description: The URL to get to the next set of results, if there are any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NewRegionFrontloadRelease_GenerateManifest (new)
Description :  Generates the new region frontload manifest.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/generateNewRegionFrontloadManifest
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
properties:
{
Required: True ,
}
{
properties:
{
Description: Properties of the frontload payload. ,
Required: True ,
}
{
operationType:
{
Description: The operation type. ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The provider namespace. ,
Required: True ,
}
string ,
frontloadLocation:
{
Description: The frontload location. ,
Required: True ,
}
string ,
copyFromLocation:
{
Description: The copy from location. ,
Required: True ,
}
string ,
environmentType:
{
Description: The environment type. ,
Enum:
{
NotSpecified: No description available. ,
Canary: No description available. ,
Prod: No description available. ,
All: No description available. ,
Mooncake: No description available. ,
Fairfax: No description available. ,
}
,
Required: True ,
}
enum ,
serviceFeatureFlag:
{
Description: The service feature flag. ,
Enum:
{
DoNotCreate: No description available. ,
Create: No description available. ,
}
,
Required: True ,
}
enum ,
includeResourceTypes:
{
Description: The resource types to include. ,
Required: True ,
}
[
string ,
]
,
excludeResourceTypes:
{
Description: The resource types to exclude. ,
Required: True ,
}
[
string ,
]
,
overrideManifestLevelFields:
{
Description: The manifest level fields to override. ,
Required: True ,
}
string ,
overrideEndpointLevelFields:
{
Description: The endpoint level fields to override. ,
Required: True ,
}
string ,
ignoreFields:
{
Description: The fields to ignore. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
providerAuthentication:
{
Description: The provider authentication. ,
Required: False ,
}
string ,
providerAuthorizations:
{
Description: The provider authorizations. ,
Required: False ,
}
[
{
applicationId:
{
Description: The application id. ,
Required: False ,
}
string ,
roleDefinitionId:
{
Description: The role definition id. ,
Required: False ,
}
string ,
managedByRoleDefinitionId:
{
Description: The managed by role definition id. ,
Required: False ,
}
string ,
managedByAuthorization:
{
Description: Managed by authorization. ,
Required: False ,
}
{
additionalAuthorizations:
{
Required: False ,
}
[
{
applicationId:
{
Required: False ,
}
string ,
roleDefinitionId:
{
Required: False ,
}
string ,
}
,
]
,
managedByResourceRoleDefinitionId:
{
Description: The managed by resource role definition ID for the application. ,
Required: False ,
}
string ,
allowManagedByInheritance:
{
Description: Indicates whether the managed by resource role definition ID should be inherited. ,
Required: False ,
}
boolean ,
}
,
allowedThirdPartyExtensions:
{
Description: The allowed third party extensions. ,
Required: False ,
}
[
{
name:
{
Description: Name of third party extension. ,
Required: False ,
}
string ,
}
,
]
,
groupingTag:
{
Description: The grouping tag. ,
Required: False ,
}
string ,
}
,
]
,
namespace:
{
Description: The namespace. ,
Required: False ,
}
string ,
services:
{
Description: The services. ,
Required: False ,
}
[
{
serviceName:
{
Description: The service name. ,
Required: False ,
}
string ,
status:
{
Description: The status. ,
Enum:
{
Active: No description available. ,
Inactive: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
serviceName:
{
Description: The service name. ,
Required: False ,
}
string ,
providerVersion:
{
Description: The provider version. ,
Required: False ,
}
string ,
providerType:
{
Description: The provider type. ,
Enum:
{
NotSpecified: No description available. ,
Internal: No description available. ,
External: No description available. ,
Hidden: No description available. ,
RegistrationFree: No description available. ,
LegacyRegistrationRequired: No description available. ,
TenantOnly: No description available. ,
AuthorizationFree: No description available. ,
}
,
Required: False ,
}
enum ,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
featuresRule:
{
Description: The features rule. ,
Required: False ,
}
string ,
requestHeaderOptions:
{
Description: The request header options. ,
Required: False ,
}
string ,
resourceTypes:
{
Description: The resource types. ,
Required: False ,
}
[
{
name:
{
Description: The resource type name. ,
Required: False ,
}
string ,
routingType:
{
Description: The resource routing type. ,
Enum:
{
Default: The resource routing type is default. ,
ProxyOnly: The resource routing type is proxy only. ,
HostBased: The resource routing type is host based. ,
Extension: The resource routing type is extension. ,
Tenant: The resource routing type is tenant. ,
Fanout: The resource routing type is fanout. ,
LocationBased: The resource routing type is location based. ,
Failover: The resource routing type is failover. ,
CascadeExtension: The resource routing type is cascade extension. ,
ChildFanout: The resource routing type is child fanout. ,
CascadeAuthorizedExtension: The resource routing type is cascade authorized extension. ,
BypassEndpointSelectionOptimization: The resource routing type is bypass endpoint selection optimization. ,
LocationMapping: The resource routing type is location mapping. ,
ServiceFanout: The resource routing type is service fanout. ,
}
,
Required: False ,
}
enum ,
additionalOptions:
{
Description: The additional options. ,
Enum:
{
ProtectedAsyncOperationPolling: No description available. ,
ProtectedAsyncOperationPollingAuditOnly: No description available. ,
}
,
Required: False ,
}
enum ,
crossTenantTokenValidation:
{
Description: The cross tenant token validation. ,
Enum:
{
EnsureSecureValidation: No description available. ,
PassthroughInsecureToken: No description available. ,
}
,
Required: False ,
}
enum ,
resourceValidation:
{
Description: The resource validation. ,
Enum:
{
NotSpecified: No description available. ,
ReservedWords: No description available. ,
ProfaneWords: No description available. ,
}
,
Required: False ,
}
enum ,
allowedUnauthorizedActions:
{
Description: The allowed unauthorized actions. ,
Required: False ,
}
[
string ,
]
,
allowedUnauthorizedActionsExtensions:
{
Description: The allowed unauthorized actions extensions. ,
Required: False ,
}
[
{
action:
{
Description: The action. ,
Required: False ,
}
string ,
intent:
{
Description: The intent. ,
Enum:
{
NOT_SPECIFIED: Default value. ,
LOW_PRIVILEGE: Data is not sensitive and ok to access. ,
DEFERRED_ACCESS_CHECK: Used for RP's using a custom authorization check outside of ARM. ,
RP_CONTRACT: RP contract allows certain operations to be unauthorized action. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
authorizationActionMappings:
{
Description: The authorization action mappings. ,
Required: False ,
}
[
{
original:
{
Description: The original action name. ,
Required: False ,
}
string ,
desired:
{
Description: The desired action name. ,
Required: False ,
}
string ,
}
,
]
,
linkedAccessChecks:
{
Description: The linked access checks. ,
Required: False ,
}
[
{
actionName:
{
Description: The action name. ,
Required: False ,
}
string ,
linkedProperty:
{
Description: The linked property. ,
Required: False ,
}
string ,
linkedAction:
{
Description: The linked action. ,
Required: False ,
}
string ,
linkedActionVerb:
{
Description: The linked action verb. ,
Required: False ,
}
string ,
linkedType:
{
Description: The linked type. ,
Required: False ,
}
string ,
}
,
]
,
defaultApiVersion:
{
Description: The default api version. ,
Required: False ,
}
string ,
loggingRules:
{
Description: The logging rules. ,
Required: False ,
}
[
{
action:
{
Description: The action. ,
Required: True ,
}
string ,
direction:
{
Description: The direction. ,
Enum:
{
None: No description available. ,
Request: No description available. ,
Response: No description available. ,
}
,
Required: True ,
}
enum ,
detailLevel:
{
Description: The detail level. ,
Enum:
{
None: No description available. ,
Body: No description available. ,
}
,
Required: True ,
}
enum ,
hiddenPropertyPaths:
{
Description: The hidden property paths. ,
Required: False ,
}
string ,
}
,
]
,
throttlingRules:
{
Description: The throttling rules. ,
Required: False ,
}
[
{
action:
{
Description: The action. ,
Required: True ,
}
string ,
metrics:
{
Description: The metrics. ,
Required: True ,
}
[
{
type:
{
Description: The throttling metric type ,
Enum:
{
NotSpecified: No description available. ,
NumberOfRequests: No description available. ,
NumberOfResources: No description available. ,
}
,
Required: True ,
}
enum ,
limit:
{
Description: The limit. ,
Format: int64 ,
Required: True ,
}
integer ,
interval:
{
Description: The interval. ,
Format: duration ,
Required: False ,
}
string ,
}
,
]
,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
applicationId:
{
Description: The application id. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
endpoints:
{
Description: The endpoints. ,
Required: False ,
}
[
{
enabled:
{
Description: Whether the endpoint is enabled. ,
Required: False ,
}
boolean ,
apiVersions:
{
Description: The api versions. ,
Required: False ,
}
[
string ,
]
,
endpointUri:
{
Description: The endpoint uri. ,
Required: False ,
}
string ,
locations:
{
Description: The locations. ,
Required: False ,
}
[
string ,
]
,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
featuresRule:
{
Description: The feature rules. ,
Required: False ,
}
string ,
timeout:
{
Description: The timeout. ,
Format: duration ,
Required: False ,
}
string ,
endpointType:
{
Description: The endpoint type. ,
Enum:
{
NotSpecified: No description available. ,
Canary: No description available. ,
Production: No description available. ,
TestInProduction: No description available. ,
}
,
Required: False ,
}
enum ,
skuLink:
{
Description: The sku link. ,
Required: False ,
}
string ,
}
,
]
,
marketplaceType:
{
Description: The marketplace type. ,
Enum:
{
NotSpecified: No description available. ,
AddOn: No description available. ,
Bypass: No description available. ,
Store: No description available. ,
}
,
Required: False ,
}
enum ,
identityManagement:
{
Description: The identity management. ,
Required: False ,
}
string ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
featuresRule:
{
Description: The features rule. ,
Required: False ,
}
string ,
subscriptionStateRules:
{
Description: The subscription state rules. ,
Required: False ,
}
[
{
state:
{
Description: The subscription state. ,
Enum:
{
NotDefined: No description available. ,
Enabled: No description available. ,
Warned: No description available. ,
PastDue: No description available. ,
Disabled: No description available. ,
Deleted: No description available. ,
}
,
Required: False ,
}
enum ,
allowedActions:
{
Description: The allowed actions. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
serviceTreeInfos:
{
Description: The service tree infos. ,
Required: False ,
}
[
{
serviceId:
{
Description: The service id. ,
Required: False ,
}
string ,
componentId:
{
Description: The component id. ,
Required: False ,
}
string ,
readiness:
{
Description: The readiness. ,
Enum:
{
ClosingDown: No description available. ,
Deprecated: No description available. ,
GA: No description available. ,
InDevelopment: No description available. ,
InternalOnly: No description available. ,
PrivatePreview: No description available. ,
PublicPreview: No description available. ,
RemovedFromARM: No description available. ,
Retired: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
requestHeaderOptions:
{
Description: The request header options. ,
Required: False ,
}
string ,
skuLink:
{
Description: The sku link. ,
Required: False ,
}
string ,
disallowedActionVerbs:
{
Description: The disallowed action verbs. ,
Required: False ,
}
[
string ,
]
,
templateDeploymentPolicy:
{
Description: The template deployment policy. ,
Required: False ,
}
string ,
extendedLocations:
{
Description: The extended locations. ,
Required: False ,
}
[
{
type:
{
Description: The type. ,
Enum:
{
NotSpecified: The extended location type is not specified. ,
CustomLocation: The extended location type is custom location. ,
EdgeZone: The extended location type is edge zone. ,
ArcZone: The extended location type is arc zone. ,
}
,
Required: False ,
}
enum ,
supportedPolicy:
{
Enum:
{
NotSpecified: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
linkedOperationRules:
{
Description: The linked operation rules. ,
Required: False ,
}
[
{
linkedOperation:
{
Description: The linked operation. ,
Enum:
{
None: No description available. ,
CrossResourceGroupResourceMove: No description available. ,
CrossSubscriptionResourceMove: No description available. ,
}
,
Required: True ,
}
enum ,
linkedAction:
{
Description: The linked action. ,
Enum:
{
NotSpecified: No description available. ,
Blocked: No description available. ,
Validate: No description available. ,
Enabled: No description available. ,
}
,
Required: True ,
}
enum ,
dependsOnTypes:
{
Description: Depends on types. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
resourceDeletionPolicy:
{
Description: The resource deletion policy. ,
Enum:
{
NotSpecified: No description available. ,
Cascade: No description available. ,
Force: No description available. ,
}
,
Required: False ,
}
enum ,
quotaRule:
{
Description: The quota rule. ,
Required: False ,
}
{
quotaPolicy:
{
Description: The quota policy. ,
Enum:
{
Default: No description available. ,
None: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
locationRules:
{
Description: The location rules. ,
Required: False ,
}
[
{
policy:
{
Description: The policy. ,
Enum:
{
Default: No description available. ,
None: No description available. ,
Restricted: No description available. ,
}
,
Required: False ,
}
enum ,
quotaId:
{
Description: The quota id. ,
Required: False ,
}
string ,
location:
{
Description: The location. ,
Required: False ,
}
string ,
}
,
]
,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
}
,
notifications:
{
Description: The notifications. ,
Required: False ,
}
[
{
notificationType:
{
Description: The notification type. ,
Enum:
{
Unspecified: No description available. ,
SubscriptionNotification: No description available. ,
}
,
Required: False ,
}
enum ,
skipNotifications:
{
Description: Whether notifications should be skipped. ,
Enum:
{
Unspecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
linkedNotificationRules:
{
Description: The linked notification rules. ,
Required: False ,
}
[
{
actions:
{
Description: The actions. ,
Required: False ,
}
[
string ,
]
,
actionsOnFailedOperation:
{
Description: The actions on failed operation. ,
Required: False ,
}
[
string ,
]
,
fastPathActions:
{
Description: The fast path actions. ,
Required: False ,
}
[
string ,
]
,
fastPathActionsOnFailedOperation:
{
Description: The fast path action on failed operation. ,
Required: False ,
}
[
string ,
]
,
linkedNotificationTimeout:
{
Description: This is a TimeSpan property. ,
Format: duration ,
Required: False ,
}
string ,
}
,
]
,
resourceProviderAuthorizationRules:
{
Description: The resource provider authorization rules. ,
Required: False ,
}
{
asyncOperationPollingRules:
{
Description: The async operation polling rules. ,
Required: False ,
}
{
authorizationActions:
{
Description: The authorization actions. ,
Required: False ,
}
[
string ,
]
,
additionalOptions:
{
Description: The additional options. ,
Enum:
{
ProtectedAsyncOperationPolling: No description available. ,
ProtectedAsyncOperationPollingAuditOnly: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}
,
]
,
management:
{
Description: The resource provider management. ,
Required: False ,
}
string ,
capabilities:
{
Description: The capabilities. ,
Required: False ,
}
[
{
quotaId:
{
Description: The quota id. ,
Required: True ,
}
string ,
effect:
{
Description: The effect. ,
Enum:
{
NotSpecified: No description available. ,
Allow: No description available. ,
Disallow: No description available. ,
}
,
Required: True ,
}
enum ,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
crossTenantTokenValidation:
{
Description: The cross tenant token validation. ,
Enum:
{
EnsureSecureValidation: No description available. ,
PassthroughInsecureToken: No description available. ,
}
,
Required: False ,
}
enum ,
metadata:
{
Description: The metadata. ,
Required: False ,
}
object ,
globalNotificationEndpoints:
{
Description: The global notification endpoints. ,
Required: False ,
}
[
{
enabled:
{
Description: Whether the endpoint is enabled. ,
Required: False ,
}
boolean ,
apiVersions:
{
Description: The api versions. ,
Required: False ,
}
[
string ,
]
,
endpointUri:
{
Description: The endpoint uri. ,
Required: False ,
}
string ,
locations:
{
Description: The locations. ,
Required: False ,
}
[
string ,
]
,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
featuresRule:
{
Description: The feature rules. ,
Required: False ,
}
string ,
timeout:
{
Description: The timeout. ,
Format: duration ,
Required: False ,
}
string ,
endpointType:
{
Description: The endpoint type. ,
Enum:
{
NotSpecified: No description available. ,
Canary: No description available. ,
Production: No description available. ,
TestInProduction: No description available. ,
}
,
Required: False ,
}
enum ,
skuLink:
{
Description: The sku link. ,
Required: False ,
}
string ,
}
,
]
,
reRegisterSubscriptionMetadata:
{
Description: The re-register subscription metadata. ,
Required: False ,
}
string ,
enableTenantLinkedNotification:
{
Description: Whether tenant linked notification is enabled. ,
Required: False ,
}
boolean ,
notifications:
{
Description: The notifications. ,
Required: False ,
}
[
{
notificationType:
{
Description: The notification type. ,
Enum:
{
Unspecified: No description available. ,
SubscriptionNotification: No description available. ,
}
,
Required: False ,
}
enum ,
skipNotifications:
{
Description: Whether notifications should be skipped. ,
Enum:
{
Unspecified: No description available. ,
Enabled: No description available. ,
Disabled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
linkedNotificationRules:
{
Description: The linked notification rules. ,
Required: False ,
}
[
{
tokenAuthConfiguration:
{
Description: The token auth configuration. ,
Required: False ,
}
{
authenticationScheme:
{
Description: The authentication scheme. ,
Enum:
{
PoP: No description available. ,
Bearer: No description available. ,
}
,
Required: False ,
}
enum ,
signedRequestScope:
{
Description: The signed request scope. ,
Enum:
{
ResourceUri: No description available. ,
Endpoint: No description available. ,
}
,
Required: False ,
}
enum ,
disableCertificateAuthenticationFallback:
{
Description: Whether certification authentication fallback is disabled. ,
Required: False ,
}
boolean ,
}
,
actions:
{
Description: The actions. ,
Required: False ,
}
[
string ,
]
,
endpoints:
{
Description: The endpoints. ,
Required: False ,
}
[
{
enabled:
{
Description: Whether the endpoint is enabled. ,
Required: False ,
}
boolean ,
apiVersions:
{
Description: The api versions. ,
Required: False ,
}
[
string ,
]
,
endpointUri:
{
Description: The endpoint uri. ,
Required: False ,
}
string ,
locations:
{
Description: The locations. ,
Required: False ,
}
[
string ,
]
,
requiredFeatures:
{
Description: The required features. ,
Required: False ,
}
[
string ,
]
,
featuresRule:
{
Description: The feature rules. ,
Required: False ,
}
string ,
timeout:
{
Description: The timeout. ,
Format: duration ,
Required: False ,
}
string ,
endpointType:
{
Description: The endpoint type. ,
Enum:
{
NotSpecified: No description available. ,
Canary: No description available. ,
Production: No description available. ,
TestInProduction: No description available. ,
}
,
Required: False ,
}
enum ,
skuLink:
{
Description: The sku link. ,
Required: False ,
}
string ,
}
,
]
,
dstsConfiguration:
{
Description: The dsts configuration. ,
Required: False ,
}
string ,
}
,
]
,
resourceProviderAuthorizationRules:
{
Description: The resource provider authorization rules. ,
Required: False ,
}
{
asyncOperationPollingRules:
{
Description: The async operation polling rules. ,
Required: False ,
}
{
authorizationActions:
{
Description: The authorization actions. ,
Required: False ,
}
[
string ,
]
,
additionalOptions:
{
Description: The additional options. ,
Enum:
{
ProtectedAsyncOperationPolling: No description available. ,
ProtectedAsyncOperationPollingAuditOnly: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NewRegionFrontloadRelease_CreateOrUpdate (new)
Description :  Creates or updates a new region frontload release.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/newRegionFrontloadRelease/{releaseName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
releaseName:
{
Description: The name of the release. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
properties:
{
Required: True ,
}
{
properties:
{
Description: Properties of the frontload payload. ,
Required: True ,
}
{
operationType:
{
Description: The operation type. ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The provider namespace. ,
Required: True ,
}
string ,
frontloadLocation:
{
Description: The frontload location. ,
Required: True ,
}
string ,
copyFromLocation:
{
Description: The copy from location. ,
Required: True ,
}
string ,
environmentType:
{
Description: The environment type. ,
Enum:
{
NotSpecified: No description available. ,
Canary: No description available. ,
Prod: No description available. ,
All: No description available. ,
Mooncake: No description available. ,
Fairfax: No description available. ,
}
,
Required: True ,
}
enum ,
serviceFeatureFlag:
{
Description: The service feature flag. ,
Enum:
{
DoNotCreate: No description available. ,
Create: No description available. ,
}
,
Required: True ,
}
enum ,
includeResourceTypes:
{
Description: The resource types to include. ,
Required: True ,
}
[
string ,
]
,
excludeResourceTypes:
{
Description: The resource types to exclude. ,
Required: True ,
}
[
string ,
]
,
overrideManifestLevelFields:
{
Description: The manifest level fields to override. ,
Required: True ,
}
string ,
overrideEndpointLevelFields:
{
Description: The endpoint level fields to override. ,
Required: True ,
}
string ,
ignoreFields:
{
Description: The fields to ignore. ,
Required: True ,
}
[
string ,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the rollout. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: The default rollout specification. ,
Required: False ,
}
string ,
status:
{
Description: The default rollout status. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
properties:
{
Description: Properties of the rollout. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: The default rollout specification. ,
Required: False ,
}
string ,
status:
{
Description: The default rollout status. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NewRegionFrontloadRelease_Get (new)
Description :  Gets a new region frontload release.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/newRegionFrontloadRelease/{releaseName}
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
releaseName:
{
Description: The name of the release. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
properties:
{
Description: Properties of the rollout. ,
Required: False ,
}
{
provisioningState:
{
Description: The provisioned state of the resource. ,
Enum:
{
NotSpecified: No description available. ,
Accepted: No description available. ,
Running: 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. ,
MovingResources: No description available. ,
TransientFailure: No description available. ,
RolloutInProgress: No description available. ,
}
,
Required: False ,
}
enum ,
specification:
{
Description: The default rollout specification. ,
Required: False ,
}
string ,
status:
{
Description: The default rollout status. ,
Required: False ,
}
string ,
}
,
systemData:
{
Description: Metadata pertaining to creation and last modification of the resource. ,
Required: False ,
}
{
createdBy:
{
Description: The identity that created the resource. ,
Required: False ,
}
string ,
createdByType:
{
Description: The type of identity that created the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
createdAt:
{
Description: The timestamp of resource creation (UTC). ,
Format: date-time ,
Required: False ,
}
string ,
lastModifiedBy:
{
Description: The identity that last modified the resource. ,
Required: False ,
}
string ,
lastModifiedByType:
{
Description: The type of identity that last modified the resource. ,
Enum:
{
User: No description available. ,
Application: No description available. ,
ManagedIdentity: No description available. ,
Key: No description available. ,
}
,
Required: False ,
}
enum ,
lastModifiedAt:
{
Description: The timestamp of resource last modification (UTC) ,
Format: date-time ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}
NewRegionFrontloadRelease_Stop (new)
Description :  Stops a new region frontload release.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.ProviderHub/providerRegistrations/{providerNamespace}/newRegionFrontloadRelease/{releaseName}/stop
{
subscriptionId:
{
Description: The ID of the target subscription. The value must be an UUID. ,
Format: uuid ,
Required: True ,
}
string ,
providerNamespace:
{
Description: The name of the resource provider hosted within ProviderHub. ,
Required: True ,
}
string ,
releaseName:
{
Description: The name of the release. ,
Required: True ,
}
string ,
api-version:
{
Description: The API version to use for this operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
Description: The error object. ,
Required: False ,
}
{
code:
{
Description: The error code. ,
Required: False ,
}
string ,
message:
{
Description: The error message. ,
Required: False ,
}
string ,
target:
{
Description: The error target. ,
Required: False ,
}
string ,
details:
{
Description: The error details. ,
Required: False ,
}
[
string ,
]
,
additionalInfo:
{
Description: The error additional info. ,
Required: False ,
}
[
{
type:
{
Description: The additional info type. ,
Required: False ,
}
string ,
info:
{
Description: The additional info. ,
Required: False ,
}
object ,
}
,
]
,
}
,
}