az providerhub resource-type-registration
Note
This reference is part of the providerhub extension for the Azure CLI (version 2.57.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 |
Delete a resource type. |
Extension | GA |
az providerhub resource-type-registration list |
List the list of the resource types for the given provider. |
Extension | GA |
az providerhub resource-type-registration show |
Get a resource type details in the given subscription and provider. |
Extension | GA |
az providerhub resource-type-registration update |
Update a resource type. |
Extension | GA |
az providerhub resource-type-registration wait |
Place the CLI in a waiting state until a condition is met. |
Extension | GA |
az providerhub resource-type-registration create
Create a resource type.
az providerhub resource-type-registration create --name --resource-type
--provider-namespace
[--add-resource-list-target-locations --add-target-locations {0, 1, f, false, n, no, t, true, y, yes}]
[--additional-options {ProtectedAsyncOperationPolling, ProtectedAsyncOperationPollingAuditOnly}]
[--allow-empty-role --allow-empty-role-assignments {0, 1, f, false, n, no, t, true, y, yes}]
[--allowed-resource-names]
[--allowed-templ-actions --allowed-template-deployment-reference-actions]
[--allowed-unauthorized-actions --aua]
[--api-profiles]
[--async-op-rt-name --async-operation-resource-type-name]
[--async-timeout-rules]
[--auth-mapping --auth-mappings --auth-mappings --authorization-action-mappings]
[--availability-zone-rule]
[--capacity-rule]
[--category {FreeForm, Internal, None, PureProxy}]
[--check-name-availability-specifications --checkname-specs]
[--common-api-versions]
[--concurrency-options --resource-concurrency-control-options]
[--creation-begin --resource-creation-begin]
[--cross-tenant-token-validation --token-validation {EnsureSecureValidation, PassthroughInsecureToken}]
[--dav --disallowed-action-verbs]
[--default-api-version]
[--deletion-policy --resource-deletion-policy {CascadeDeleteAll, CascadeDeleteProxyOnlyChildren, NotSpecified}]
[--disallowed-end-user-operations --disallowed-ops]
[--dsts-configuration]
[--enable-3p-s2s --enable-third-party-s2-s {0, 1, f, false, n, no, t, true, y, yes}]
[--enable-async-operation {0, 1, f, false, n, no, t, true, y, yes}]
[--endpoint --endpoints]
[--extended-location --extended-locations --extended-locations]
[--frontdoor-request-mode {NotSpecified, UseManifest}]
[--grouping-tag]
[--identity-management]
[--is-pure-proxy {0, 1, f, false, n, no, t, true, y, yes}]
[--kind {Direct, Hybrid, Managed}]
[--legacy-name]
[--legacy-names]
[--legacy-policy]
[--linked-access-check --linked-access-checks --linked-access-checks]
[--linked-notif-rules --linked-notification-rules]
[--linked-operation-rules]
[--logging-rule --logging-rules --logging-rules]
[--managed-resource-group-configuration --managed-rg-config]
[--management]
[--manifest-link]
[--marketplace-options]
[--marketplace-type {AddOn, Bypass, NotSpecified, Store}]
[--metadata]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--notifications]
[--on-behalf-of-tokens]
[--open-api-configuration]
[--opt-in-headers {ClientGroupMembership, ClientPrincipalNameEncoded, MSIResourceIdEncoded, ManagementGroupAncestorsEncoded, NotSpecified, PrivateLinkId, PrivateLinkResourceId, PrivateLinkVnetTrafficTag, ResourceGroupLocation, SignedAuxiliaryTokens, SignedUserToken, UnboundedClientGroupMembership}]
[--opt-out-headers {NotSpecified, SystemDataCreatedByLastModifiedBy}]
[--override-actions --subscription-state-override-actions]
[--policy-execution-type {BypassPolicies, ExecutePolicies, ExpectPartialPutRequests, NotSpecified}]
[--priv-endpoint-config --private-endpoint-configuration]
[--quota-rule]
[--regionality {Global, NotSpecified, Regional}]
[--req-features-policy --required-features-policy {All, Any}]
[--required-features]
[--resource-cache]
[--resource-graph-config --resource-graph-configuration]
[--resource-management-options --resource-mgmt-options]
[--resource-move-policy]
[--resource-provider-authorization-rules --rp-auth-rules]
[--resource-query-management --resource-query-mgmt]
[--resource-sub-type {AsyncOperation, NotSpecified}]
[--resource-type-common-attribute-management --rt-common-mgmt]
[--resource-validation {NotSpecified, ProfaneWords, ReservedWords}]
[--routing-rule]
[--routing-type]
[--service-tree-info --service-tree-infos --service-tree-infos]
[--sku-link]
[--soft-delete-ttl]
[--sub-state-rule --sub-state-rules --sub-state-rules --subscription-state-rules]
[--supports-tags {0, 1, f, false, n, no, t, true, y, yes}]
[--swagger-specification --swagger-specifications --swagger-specifications]
[--template-deployment-options --tmplt-deploy-opt]
[--template-deployment-policy --tmplt-deploy-policy]
[--throttling-rule --throttling-rules --throttling-rules]
[--token-auth-config --token-auth-configuration]
Examples
resource-type-registration create
az providerhub resource-type-registration create --endpoints [{api-versions:[2019-01-01],locations:[WestUS]}] --regionality "Regional" --provider-namespace "{providerNamespace}" --resource-type "extensionresourcetype"
Required Parameters
The resource type.
The name of the resource provider hosted within ProviderHub.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Add resource list target locations?
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
The additional options.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | ProtectedAsyncOperationPolling, ProtectedAsyncOperationPollingAuditOnly |
Determines if empty role assignments are allowed.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Allowed template deployment reference actions. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The allowed unauthorized actions. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The async operation resource type name.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Async timeout rules Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Allows RP to override action verb for RBAC purposes at ARM. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --auth-mapping
--auth-mappings
.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Capacity rule. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The category.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | FreeForm, Internal, None, PureProxy |
Name availability checks feature at the platform level. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Common API versions for the resource type. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The resource concurrency control options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Extension options for handling the resource creation begin extension request. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | ExtensionOptions Arguments |
The cross tenant token validation.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | EnsureSecureValidation, PassthroughInsecureToken |
The disallowed action verbs. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The default API version for the endpoint.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The resource deletion policy.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | CascadeDeleteAll, CascadeDeleteProxyOnlyChildren, NotSpecified |
The disallowed end user operations. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The DSTS configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Indicates whether third party s2s is enabled for this resource type.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Indicates whether the async operation is enabled for this resource type.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
The resource type endpoints. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --endpoint
.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The extended location options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --extended-location
--extended-locations
.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The frontdoor request mode.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | NotSpecified, UseManifest |
Grouping tag.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
MSI related settings. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Indicates whether this is a PureProxy resource type.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Resource type registration kind. This Metadata is also used by portal/tooling/etc to render different UX experiences for resources of the same type.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Default value: | Managed |
Accepted values: | Direct, Hybrid, Managed |
The legacy name.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Enables additional Role Based Access Control (RBAC) checks on related resources. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --linked-access-check
--linked-access-checks
.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The linked notification rules. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The logging rules. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --logging-rule
--logging-rules
.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The managed resource group configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Manifest link.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Marketplace options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The type of marketplace behavior for the resource type.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | AddOn, Bypass, NotSpecified, Store |
Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
The notifications object. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The opt-in headers.
Property | Value |
---|---|
Parameter group: | RequestHeaderOptions Arguments |
Accepted values: | ClientGroupMembership, ClientPrincipalNameEncoded, MSIResourceIdEncoded, ManagementGroupAncestorsEncoded, NotSpecified, PrivateLinkId, PrivateLinkResourceId, PrivateLinkVnetTrafficTag, ResourceGroupLocation, SignedAuxiliaryTokens, SignedUserToken, UnboundedClientGroupMembership |
The opt-out headers.
Property | Value |
---|---|
Parameter group: | RequestHeaderOptions Arguments |
Accepted values: | NotSpecified, SystemDataCreatedByLastModifiedBy |
The subscription state override actions. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | SubscriptionLifecycleNotificationSpecifications Arguments |
The policy execution type.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | BypassPolicies, ExecutePolicies, ExpectPartialPutRequests, NotSpecified |
The private endpoint config. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The regionality of the resource type. Allowed values: Global, NotSpecified, Regional.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | Global, NotSpecified, Regional |
The accepted values are "Any" or "All".
Property | Value |
---|---|
Parameter group: | FeaturesRule Arguments |
Accepted values: | All, Any |
The required features. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Resource cache options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The resource graph configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Resource management options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The resource move policy. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The resource provider authorization rules. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Resource query management options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The resource sub type.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | AsyncOperation, NotSpecified |
Resource type common attribute management. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The resource validation.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | NotSpecified, ProfaneWords, ReservedWords |
Routing rule. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The resource routing type. The options are: CascadeExtension, Default, Extension, Failover, Fanout, HostBased, LocationBased, ProxyOnly, Tenant. Select multiple with a comma separated string.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The ServiceTree information for the resource provider. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --service-tree-info
--service-tree-infos
.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The sku link.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The soft delete time to live.
Property | Value |
---|---|
Parameter group: | SubscriptionLifecycleNotificationSpecifications Arguments |
The subscription state rules. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --sub-state-rule
--sub-state-rules
.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Determines if tags are supported.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
The swagger spec of the resource type. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --swagger-specification
--swagger-specifications
.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The template deployment options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The template deployment policy. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Enables setting individual limits for different actions in terms of number of requests or number of resources (for collection read requests only). Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --throttling-rule
--throttling-rules
.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The token auth configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
az providerhub resource-type-registration delete
Delete a resource type.
az providerhub resource-type-registration delete [--ids]
[--name --resource-type]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--provider-namespace]
[--subscription]
[--yes]
Examples
resource-type-registration delete
az providerhub resource-type-registration delete -y --provider-namespace "{providerNamespace}" --resource-type "extensionresourcetype"
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The resource type.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
The name of the resource provider hosted within ProviderHub.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Do not prompt for confirmation.
Property | Value |
---|---|
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az providerhub resource-type-registration list
List the list of the resource types for the given provider.
az providerhub resource-type-registration list --provider-namespace
[--max-items]
[--next-token]
Examples
resource-type-registration list
az providerhub resource-type-registration list --provider-namespace "{providerNamespace}"
Required Parameters
The name of the resource provider hosted within ProviderHub.
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Total number of items to return in the command's output. If the total number of items available is more than the value specified, a token is provided in the command's output. To resume pagination, provide the token value in --next-token
argument of a subsequent command.
Property | Value |
---|---|
Parameter group: | Pagination Arguments |
Token to specify where to start paginating. This is the token value from a previously truncated response.
Property | Value |
---|---|
Parameter group: | Pagination Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
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.
Property | Value |
---|---|
Default value: | False |
az providerhub resource-type-registration show
Get a resource type details in the given subscription and provider.
az providerhub resource-type-registration show [--ids]
[--name --resource-type]
[--provider-namespace]
[--subscription]
Examples
resource-type-registration show
az providerhub resource-type-registration show --provider-namespace "{providerNamespace}" --resource-type "extensionresourcetype"
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
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.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The resource type.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The name of the resource provider hosted within ProviderHub.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az providerhub resource-type-registration update
Update a resource type.
az providerhub resource-type-registration update [--add]
[--add-resource-list-target-locations --add-target-locations {0, 1, f, false, n, no, t, true, y, yes}]
[--additional-options {ProtectedAsyncOperationPolling, ProtectedAsyncOperationPollingAuditOnly}]
[--allow-empty-role --allow-empty-role-assignments {0, 1, f, false, n, no, t, true, y, yes}]
[--allowed-resource-names]
[--allowed-templ-actions --allowed-template-deployment-reference-actions]
[--allowed-unauthorized-actions --aua]
[--api-profiles]
[--async-op-rt-name --async-operation-resource-type-name]
[--async-timeout-rules]
[--auth-mapping --auth-mappings --auth-mappings --authorization-action-mappings]
[--availability-zone-rule]
[--capacity-rule]
[--category {FreeForm, Internal, None, PureProxy}]
[--check-name-availability-specifications --checkname-specs]
[--common-api-versions]
[--concurrency-options --resource-concurrency-control-options]
[--creation-begin --resource-creation-begin]
[--cross-tenant-token-validation --token-validation {EnsureSecureValidation, PassthroughInsecureToken}]
[--dav --disallowed-action-verbs]
[--default-api-version]
[--deletion-policy --resource-deletion-policy {CascadeDeleteAll, CascadeDeleteProxyOnlyChildren, NotSpecified}]
[--disallowed-end-user-operations --disallowed-ops]
[--dsts-configuration]
[--enable-3p-s2s --enable-third-party-s2-s {0, 1, f, false, n, no, t, true, y, yes}]
[--enable-async-operation {0, 1, f, false, n, no, t, true, y, yes}]
[--endpoint --endpoints]
[--extended-locations]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--frontdoor-request-mode {NotSpecified, UseManifest}]
[--grouping-tag]
[--identity-management]
[--ids]
[--is-pure-proxy {0, 1, f, false, n, no, t, true, y, yes}]
[--kind {Direct, Hybrid, Managed}]
[--legacy-name]
[--legacy-names]
[--legacy-policy]
[--linked-access-check --linked-access-checks --linked-access-checks]
[--linked-notif-rules --linked-notification-rules]
[--linked-operation-rules]
[--logging-rules]
[--managed-resource-group-configuration --managed-rg-config]
[--management]
[--manifest-link]
[--marketplace-options]
[--marketplace-type {AddOn, Bypass, NotSpecified, Store}]
[--metadata]
[--name --resource-type]
[--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
[--notifications]
[--on-behalf-of-tokens]
[--open-api-configuration]
[--opt-in-headers {ClientGroupMembership, ClientPrincipalNameEncoded, MSIResourceIdEncoded, ManagementGroupAncestorsEncoded, NotSpecified, PrivateLinkId, PrivateLinkResourceId, PrivateLinkVnetTrafficTag, ResourceGroupLocation, SignedAuxiliaryTokens, SignedUserToken, UnboundedClientGroupMembership}]
[--opt-out-headers {NotSpecified, SystemDataCreatedByLastModifiedBy}]
[--override-actions --subscription-state-override-actions]
[--policy-execution-type {BypassPolicies, ExecutePolicies, ExpectPartialPutRequests, NotSpecified}]
[--priv-endpoint-config --private-endpoint-configuration]
[--provider-namespace]
[--quota-rule]
[--regionality {Global, NotSpecified, Regional}]
[--remove]
[--req-features-policy --required-features-policy {All, Any}]
[--required-features]
[--resource-cache]
[--resource-graph-config --resource-graph-configuration]
[--resource-management-options --resource-mgmt-options]
[--resource-move-policy]
[--resource-provider-authorization-rules --rp-auth-rules]
[--resource-query-management --resource-query-mgmt]
[--resource-sub-type {AsyncOperation, NotSpecified}]
[--resource-type-common-attribute-management --rt-common-mgmt]
[--resource-validation {NotSpecified, ProfaneWords, ReservedWords}]
[--routing-rule]
[--routing-type]
[--service-tree-info --service-tree-infos --service-tree-infos]
[--set]
[--sku-link]
[--soft-delete-ttl]
[--sub-state-rule --sub-state-rules --sub-state-rules --subscription-state-rules]
[--subscription]
[--supports-tags {0, 1, f, false, n, no, t, true, y, yes}]
[--swagger-specification --swagger-specifications --swagger-specifications]
[--template-deployment-options --tmplt-deploy-opt]
[--template-deployment-policy --tmplt-deploy-policy]
[--throttling-rule --throttling-rules --throttling-rules]
[--token-auth-config --token-auth-configuration]
Examples
resource-type-registration update
az providerhub resource-type-registration update --endpoints [{api-versions:[2019-01-01],locations:[WestUS]}] --regionality "Regional" --provider-namespace "{providerNamespace}" --resource-type "extensionresourcetype"
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Add an object to a list of objects by specifying a path and key value pairs. Example: --add property.listProperty <key=value, string or JSON string>
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Add resource list target locations?
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
The additional options.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | ProtectedAsyncOperationPolling, ProtectedAsyncOperationPollingAuditOnly |
Determines if empty role assignments are allowed.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Allowed template deployment reference actions. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The allowed unauthorized actions. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The async operation resource type name.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Async timeout rules Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Allows RP to override action verb for RBAC purposes at ARM. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --auth-mapping
--auth-mappings
.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Capacity rule. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The category.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | FreeForm, Internal, None, PureProxy |
Name availability checks feature at the platform level. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Common API versions for the resource type. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The resource concurrency control options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Extension options for handling the resource creation begin extension request. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | ExtensionOptions Arguments |
The cross tenant token validation.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | EnsureSecureValidation, PassthroughInsecureToken |
The disallowed action verbs. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The default API version for the endpoint.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The resource deletion policy.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | CascadeDeleteAll, CascadeDeleteProxyOnlyChildren, NotSpecified |
The disallowed end user operations. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The DSTS configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Indicates whether third party s2s is enabled for this resource type.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Indicates whether the async operation is enabled for this resource type.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
The resource type endpoints. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --endpoint
.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The extended location options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
The frontdoor request mode.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | NotSpecified, UseManifest |
Grouping tag.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
MSI related settings. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
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.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Indicates whether this is a PureProxy resource type.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
Resource type registration kind. This Metadata is also used by portal/tooling/etc to render different UX experiences for resources of the same type.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | Direct, Hybrid, Managed |
The legacy name.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Enables additional Role Based Access Control (RBAC) checks on related resources. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --linked-access-check
--linked-access-checks
.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The linked notification rules. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The logging rules. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The managed resource group configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Manifest link.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Marketplace options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The type of marketplace behavior for the resource type.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | AddOn, Bypass, NotSpecified, Store |
Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The resource type.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Do not wait for the long-running operation to finish.
Property | Value |
---|---|
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
The notifications object. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The opt-in headers.
Property | Value |
---|---|
Parameter group: | RequestHeaderOptions Arguments |
Accepted values: | ClientGroupMembership, ClientPrincipalNameEncoded, MSIResourceIdEncoded, ManagementGroupAncestorsEncoded, NotSpecified, PrivateLinkId, PrivateLinkResourceId, PrivateLinkVnetTrafficTag, ResourceGroupLocation, SignedAuxiliaryTokens, SignedUserToken, UnboundedClientGroupMembership |
The opt-out headers.
Property | Value |
---|---|
Parameter group: | RequestHeaderOptions Arguments |
Accepted values: | NotSpecified, SystemDataCreatedByLastModifiedBy |
The subscription state override actions. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | SubscriptionLifecycleNotificationSpecifications Arguments |
The policy execution type.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | BypassPolicies, ExecutePolicies, ExpectPartialPutRequests, NotSpecified |
The private endpoint config. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The name of the resource provider hosted within ProviderHub.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The regionality of the resource type. Allowed values: Global, NotSpecified, Regional.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | Global, NotSpecified, Regional |
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
The accepted values are "Any" or "All".
Property | Value |
---|---|
Parameter group: | FeaturesRule Arguments |
Accepted values: | All, Any |
The required features. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Resource cache options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The resource graph configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Resource management options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The resource move policy. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The resource provider authorization rules. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Resource query management options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The resource sub type.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | AsyncOperation, NotSpecified |
Resource type common attribute management. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The resource validation.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | NotSpecified, ProfaneWords, ReservedWords |
Routing rule. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The resource routing type. The options are: CascadeExtension, Default, Extension, Failover, Fanout, HostBased, LocationBased, ProxyOnly, Tenant. Select multiple with a comma separated string.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The ServiceTree information for the resource provider. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --service-tree-info
--service-tree-infos
.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
Property | Value |
---|---|
Parameter group: | Generic Update Arguments |
The sku link.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The soft delete time to live.
Property | Value |
---|---|
Parameter group: | SubscriptionLifecycleNotificationSpecifications Arguments |
The subscription state rules. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --sub-state-rule
--sub-state-rules
.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Determines if tags are supported.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Accepted values: | 0, 1, f, false, n, no, t, true, y, yes |
The swagger spec of the resource type. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --swagger-specification
--swagger-specifications
.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The template deployment options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The template deployment policy. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Enables setting individual limits for different actions in terms of number of requests or number of resources (for collection read requests only). Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --throttling-rule
--throttling-rules
.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
The token auth configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Property | Value |
---|---|
Parameter group: | Properties Arguments |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |
az providerhub resource-type-registration wait
Place the CLI in a waiting state until a condition is met.
az providerhub resource-type-registration wait [--created]
[--custom]
[--deleted]
[--exists]
[--ids]
[--interval]
[--name --resource-type]
[--provider-namespace]
[--subscription]
[--timeout]
[--updated]
Optional Parameters
The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.
Wait until created with 'provisioningState' at 'Succeeded'.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Wait until deleted.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Wait until the resource exists.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
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.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Polling interval in seconds.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | 30 |
The resource type.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
The name of the resource provider hosted within ProviderHub.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Property | Value |
---|---|
Parameter group: | Resource Id Arguments |
Maximum wait in seconds.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | 3600 |
Wait until updated with provisioningState at 'Succeeded'.
Property | Value |
---|---|
Parameter group: | Wait Condition Arguments |
Default value: | False |
Global Parameters
Increase logging verbosity to show all debug logs.
Property | Value |
---|---|
Default value: | False |
Show this help message and exit.
Only show errors, suppressing warnings.
Property | Value |
---|---|
Default value: | False |
Output format.
Property | Value |
---|---|
Default value: | json |
Accepted values: | json, jsonc, none, table, tsv, yaml, yamlc |
JMESPath query string. See http://jmespath.org/ for more information and examples.
Increase logging verbosity. Use --debug for full debug logs.
Property | Value |
---|---|
Default value: | False |