az providerhub resource-type-registration
Note
This reference is part of the providerhub extension for the Azure CLI (version 2.15.0 or higher). The extension will automatically install the first time you run an az providerhub resource-type-registration command. Learn more about extensions.
Manage resource type registration with providerhub.
Commands
| Name | Description | Type | Status |
|---|---|---|---|
| az providerhub resource-type-registration create |
Create a resource type. |
Extension | GA |
| az providerhub resource-type-registration delete |
Deletes a resource type. |
Extension | GA |
| az providerhub resource-type-registration list |
Gets the list of the resource types for the given provider. |
Extension | GA |
| az providerhub resource-type-registration show |
Gets a resource type details in the given subscription and provider. |
Extension | GA |
az providerhub resource-type-registration create
Create a resource type.
az providerhub resource-type-registration create --provider-namespace
--resource-type
[--allowed-unauthorized-actions]
[--auth-mappings]
[--check-name-availability-specifications]
[--creation-begin]
[--dav]
[--default-api-version]
[--deletion-policy {CascadeDeleteAll, CascadeDeleteProxyOnlyChildren, NotSpecified}]
[--enable-async-operation {false, true}]
[--enable-third-party-s2s {false, true}]
[--endpoints]
[--extended-locations]
[--identity-management]
[--is-pure-proxy {false, true}]
[--linked-access-checks]
[--logging-rules]
[--marketplace-type {AddOn, Bypass, NotSpecified, Store}]
[--opt-in-headers {ClientGroupMembership, NotSpecified, SignedAuxiliaryTokens, SignedUserToken, UnboundedClientGroupMembership}]
[--override-actions]
[--patch-begin]
[--regionality {Global, NotSpecified, Regional}]
[--req-features-policy {All, Any}]
[--required-features]
[--resource-move-policy]
[--routing-type]
[--service-tree-infos]
[--soft-delete-ttl]
[--sub-state-rules]
[--swagger-specifications]
[--template-deployment-options]
[--throttling-rules]Examples
ResourceTypeRegistrations_CreateOrUpdate
az providerhub resource-type-registration create --endpoints api-versions="2019-01-01" locations="Global" required-features="Microsoft.Contoso/RPaaSSampleApp" extension-endpoint-uri="https://contoso-test-extension-endpoint.com/" extension-categories="ResourceReadValidate" extension-categories="ResourceDeletionValidate" --regionality "Global" --routing-type "ProxyOnly" --swagger-specifications api-versions="2019-01-01" swagger-spec-folder-uri="https://github.com/pathtoresourceproviderswaggerspecfolder" --provider-namespace "Microsoft.Contoso" --enable-async-operation false --template-deployment-options preflight-supported="true" preflight-options="DefaultValidationOnly" preflight-options="continueDeploymentOnFailure" --resource-type "testResourceType"Required Parameters
The name of the resource provider hosted within ProviderHub.
The resource type.
Optional Parameters
The allowed unauthorized actions.
Usage: --allowed-unauthorized-actions "Microsoft.Contoso/rpResourceType/read, Microsoft.Contoso/rpResourceType/delete".
Allows RP to override action verb for RBAC purposes at ARM.
Usage: --auth-mappings original=XX desired=XX
original: Required. The original action name. desired: Required. The desired action name.
Multiple actions can be specified by using more than one --auth-mappings argument.
Name availability checks feature at the platform level.
Usage: --check-name-availability-specifications enable-default-validation=XX resource-types-with-custom-validation=XX
enable-default-validation: Boolean indicating whether RP has chosen to opt-out of RPaaS to perform check name. resource-types-with-custom-validation: The types which needs additional validation from the RP.
Extension options for handling the resource creation begin extension request.
Usage: --creation-begin request=XX response=XX request: The list of extension option types. response: The list of extension option types.
The disallowed action verbs.
Usage: --dav "read".
The default API version for the endpoint.
Usage: --default-api-version "2021-01-01".
The resource deletion policy.
Usage: --deletion-policy "CascadeDeleteAll".
Indicates whether the async operation is enabled for this resource type.
Usage: --enable-async-operation "false".
Indicates whether third party s2s is enabled for this resource type.
Usage: --enable-third-party-s2s "false".
The resource type endpoints.
Usage: --endpoints api-versions=XX locations=XX required-features=XX api-versions: Required. Comma separated list of API versions. locations: Required. Comma separated list of locations. required-features: Required. List of required features. Multiple required-features can be specified. Multiple actions can be specified by using more than one --endpoints argument.
The extended location options.
Usage: --extended-locations type=XX supported-policy=XX
type: The extended location type. supported-policy: The supported policy.
Multiple actions can be specified by using more than one --extended-locations argument.
MSI related settings.
Usage: --identity-management type=XX application-id=XX
type: The type of the identity management. application-id: The application ID that handles the identity.
Indicates whether this is a PureProxy resource type.
Usage: --is-pure-proxy "false".
Enables additional Role Based Access Control (RBAC) checks on related resources.
Usage: --linked-access-checks action-name=XX linked-property=XX linked-action=XX linked-action-verb=XX linked-type=XX
action-name: The action name. linked-property: The linked property. linked-action: The linked action. linked-action-verb: The linked action verb. linked-type: The linked type.
Multiple actions can be specified by using more than one --linked-access-checks argument.
The logging rules.
Usage: --logging-rules action=XX direction=XX detail-level=XX
action: Required. The action name. direction: Required. The direction. detail-level: Required. The detail level.
Multiple actions can be specified by using more than one --logging-rules argument.
The type of marketplace behavior for the resource type.
Usage: --marketplace-type "AddOn".
The opt-in headers.
Usage: --opt-in-headers "SignedUserToken".
The subscription state override actions.
Usage: --subscription-state-override-actions state=XX action=XX
Multiple actions can be specified by using more than one --subscription-state-override-actions argument.
Extension options for handling the resource patch begin extension request.
Usage: --patch-begin request=XX response=XX request: The list of extension option types. response: The list of extension option types.
The regionality of the resource type.
Usage: --regionality "Regional".
The accepted values are "Any" or "All". If the value is "All", then only the subscriptions registered to all the corresponding feature flag will be allowed..
Usage: --req-features-policy "All".
The required features.
Usage: --required-features "Microsoft.Contoso/feature1, Microsoft.Contoso/feature2".
The resource move policy.
Usage: --resource-move-policy validation-required=XX cross-resource-group-move-enabled=XX cross-subscription-move-enabled=XX
validation-required: Boolean indicating whether validation is required for moving the resource. cross-resource-group-move-enabled: Boolean indicating whether moving resources across resource groups is allowed. cross-subscription-move-enabled: Boolean indicating whether moving resources across subscriptions is allowed.
The resource routing type..
Usage: --routing-type "Default"
Available routing types include: Default, ProxyOnly, HostBased, Extension, Tenant, Fanout, LocationBased, Failover, CascadeExtension, ChildFanout, CascadeAuthorizedExtension, BypassEndpointSelectionOptimization.
The ServiceTree information for the resource provider.
Usage: --service-tree-infos service-id=XX component-id=XX
service-id: Required. The service ID. component-id: Required. The component ID.
Multiple actions can be specified by using more than one --service-tree-infos argument.
The soft delete time to live.
The subscription state rules.
Usage: --sub-state-rules state=XX allowed-actions=XX
state: The subscription state. allowed-actions: The allowed actions.
Multiple actions can be specified by using more than one --sub-state-rules argument.
The Swagger spec of the resource type.
Usage: --swagger-specifications api-versions=XX swagger-spec-folder-uri=XX
api-versions: Required. The resource type API versions, separated by commas. swagger-spec-folder-uri: Required. The Swagger spec URI.
Multiple actions can be specified by using more than one --swagger-specifications argument.
The template deployment options.
Usage: --template-deployment-options preflight-supported=XX preflight-options=XX
preflight-supported: Boolean indicating whether preflight validation is supported. preflight-options: The preflight options.
Enables setting individual limits for different actions in terms of number of requests or number of resources (for collection read requests only).
Usage: --throttling-rules action=XX metrics=XX required-features=XX
action: Required. The action name. metrics: Required. The throttling metrics. required-features: The throttling rule required features.
Multiple actions can be specified by using more than one --throttling-rules argument.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az providerhub resource-type-registration delete
Deletes a resource type.
az providerhub resource-type-registration delete [--ids]
[--provider-namespace]
[--resource-type]
[--subscription]
[--yes]Examples
ResourceTypeRegistrations_Delete
az providerhub resource-type-registration delete --provider-namespace "Microsoft.Contoso" --resource-type "testResourceType"Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The name of the resource provider hosted within ProviderHub.
The resource type.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az providerhub resource-type-registration list
Gets the list of the resource types for the given provider.
az providerhub resource-type-registration list --provider-namespaceExamples
ResourceTypeRegistrations_ListByProviderRegistration
az providerhub resource-type-registration list --provider-namespace "Microsoft.Contoso"Required Parameters
The name of the resource provider hosted within ProviderHub.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
az providerhub resource-type-registration show
Gets a resource type details in the given subscription and provider.
az providerhub resource-type-registration show [--ids]
[--provider-namespace]
[--resource-type]
[--subscription]Examples
ResourceTypeRegistrations_Get
az providerhub resource-type-registration show --provider-namespace "Microsoft.Contoso" --resource-type "employees"Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The name of the resource provider hosted within ProviderHub.
The resource type.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.
Increase logging verbosity. Use --debug for full debug logs.
Feedback
Kommer snart: I hele 2024 udfaser vi GitHub-problemer som feedbackmekanisme for indhold og erstatter det med et nyt feedbacksystem. Du kan få flere oplysninger under: https://aka.ms/ContentUserFeedback.
Indsend og få vist feedback om