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
                                                 --provider-namespace
                                                 [--add-resource-list-target-locations {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--additional-options {ProtectedAsyncOperationPolling, ProtectedAsyncOperationPollingAuditOnly}]
                                                 [--allow-empty-role {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--allowed-resource-names]
                                                 [--allowed-templ-actions]
                                                 [--allowed-unauthorized-actions]
                                                 [--api-profiles]
                                                 [--async-op-rt-name]
                                                 [--async-timeout-rules]
                                                 [--auth-mapping]
                                                 [--availability-zone-rule]
                                                 [--capacity-rule]
                                                 [--category {FreeForm, Internal, None, PureProxy}]
                                                 [--check-name-availability-specifications]
                                                 [--common-api-versions]
                                                 [--concurrency-options]
                                                 [--creation-begin]
                                                 [--cross-tenant-token-validation {EnsureSecureValidation, PassthroughInsecureToken}]
                                                 [--dav]
                                                 [--default-api-version]
                                                 [--deletion-policy {CascadeDeleteAll, CascadeDeleteProxyOnlyChildren, NotSpecified}]
                                                 [--disallowed-end-user-operations]
                                                 [--dsts-configuration]
                                                 [--enable-3p-s2s {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--enable-async-operation {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--endpoint]
                                                 [--extended-location]
                                                 [--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-notif-rules]
                                                 [--linked-operation-rules]
                                                 [--logging-rule]
                                                 [--managed-resource-group-configuration]
                                                 [--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]
                                                 [--policy-execution-type {BypassPolicies, ExecutePolicies, ExpectPartialPutRequests, NotSpecified}]
                                                 [--priv-endpoint-config]
                                                 [--quota-rule]
                                                 [--regionality {Global, NotSpecified, Regional}]
                                                 [--req-features-policy {All, Any}]
                                                 [--required-features]
                                                 [--resource-cache]
                                                 [--resource-graph-config]
                                                 [--resource-management-options]
                                                 [--resource-move-policy]
                                                 [--resource-provider-authorization-rules]
                                                 [--resource-query-management]
                                                 [--resource-sub-type {AsyncOperation, NotSpecified}]
                                                 [--resource-type-common-attribute-management]
                                                 [--resource-validation {NotSpecified, ProfaneWords, ReservedWords}]
                                                 [--routing-rule]
                                                 [--routing-type {CascadeExtension, Default, Extension, Failover, Fanout, HostBased, LocationBased, ProxyOnly, Tenant}]
                                                 [--service-tree-info]
                                                 [--sku-link]
                                                 [--soft-delete-ttl]
                                                 [--sub-state-rule]
                                                 [--supports-tags {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--swagger-specification]
                                                 [--template-deployment-options]
                                                 [--template-deployment-policy]
                                                 [--throttling-rule]
                                                 [--token-auth-config]

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

--name --resource-type -n

The resource type.

--provider-namespace

The name of the resource provider hosted within ProviderHub.

Optional Parameters

--add-resource-list-target-locations --add-target-locations

Add resource list target locations?

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--additional-options

The additional options.

Accepted values: ProtectedAsyncOperationPolling, ProtectedAsyncOperationPollingAuditOnly
--allow-empty-role --allow-empty-role-assignments

Determines if empty role assignments are allowed.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--allowed-resource-names

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--allowed-templ-actions --allowed-template-deployment-reference-actions

Allowed template deployment reference actions. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--allowed-unauthorized-actions --aua

The allowed unauthorized actions. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--api-profiles

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--async-op-rt-name --async-operation-resource-type-name

The async operation resource type name.

--async-timeout-rules

Async timeout rules Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--auth-mapping --auth-mappings --auth-mappings --authorization-action-mappings

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.

--availability-zone-rule

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--capacity-rule

Capacity rule. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--category

The category.

Accepted values: FreeForm, Internal, None, PureProxy
--check-name-availability-specifications --checkname-specs

Name availability checks feature at the platform level. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--common-api-versions

Common API versions for the resource type. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--concurrency-options --resource-concurrency-control-options

The resource concurrency control options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--creation-begin --resource-creation-begin

Extension options for handling the resource creation begin extension request. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--cross-tenant-token-validation --token-validation

The cross tenant token validation.

Accepted values: EnsureSecureValidation, PassthroughInsecureToken
--dav --disallowed-action-verbs

The disallowed action verbs. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--default-api-version

The default API version for the endpoint.

--deletion-policy --resource-deletion-policy

The resource deletion policy.

Accepted values: CascadeDeleteAll, CascadeDeleteProxyOnlyChildren, NotSpecified
--disallowed-end-user-operations --disallowed-ops

The disallowed end user operations. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--dsts-configuration

The DSTS configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--enable-3p-s2s --enable-third-party-s2-s

Indicates whether third party s2s is enabled for this resource type.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--enable-async-operation

Indicates whether the async operation is enabled for this resource type.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--endpoint --endpoints

The resource type endpoints. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --endpoint.

--extended-location --extended-locations --extended-locations

The extended location options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --extended-location --extended-locations.

--frontdoor-request-mode

The frontdoor request mode.

Accepted values: NotSpecified, UseManifest
--grouping-tag

Grouping tag.

--identity-management

MSI related settings. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--is-pure-proxy

Indicates whether this is a PureProxy resource type.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--kind

Resource type registration kind. This Metadata is also used by portal/tooling/etc to render different UX experiences for resources of the same type.

Accepted values: Direct, Hybrid, Managed
Default value: Managed
--legacy-name

The legacy name.

--legacy-names

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--legacy-policy

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--linked-access-check --linked-access-checks --linked-access-checks

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.

--linked-notif-rules --linked-notification-rules

The linked notification rules. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--linked-operation-rules

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--logging-rule --logging-rules --logging-rules

The logging rules. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --logging-rule --logging-rules.

--managed-resource-group-configuration --managed-rg-config

The managed resource group configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--management

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--manifest-link

Manifest link.

--marketplace-options

Marketplace options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--marketplace-type

The type of marketplace behavior for the resource type.

Accepted values: AddOn, Bypass, NotSpecified, Store
--metadata

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--notifications

The notifications object. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--on-behalf-of-tokens

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--open-api-configuration

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--opt-in-headers

The opt-in headers.

Accepted values: ClientGroupMembership, ClientPrincipalNameEncoded, MSIResourceIdEncoded, ManagementGroupAncestorsEncoded, NotSpecified, PrivateLinkId, PrivateLinkResourceId, PrivateLinkVnetTrafficTag, ResourceGroupLocation, SignedAuxiliaryTokens, SignedUserToken, UnboundedClientGroupMembership
--opt-out-headers

The opt-out headers.

Accepted values: NotSpecified, SystemDataCreatedByLastModifiedBy
--override-actions --subscription-state-override-actions

The subscription state override actions. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--policy-execution-type

The policy execution type.

Accepted values: BypassPolicies, ExecutePolicies, ExpectPartialPutRequests, NotSpecified
--priv-endpoint-config --private-endpoint-configuration

The private endpoint config. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--quota-rule

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--regionality

The regionality of the resource type. Allowed values: Global, NotSpecified, Regional.

Accepted values: Global, NotSpecified, Regional
--req-features-policy --required-features-policy

The accepted values are "Any" or "All".

Accepted values: All, Any
--required-features

The required features. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resource-cache

Resource cache options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resource-graph-config --resource-graph-configuration

The resource graph configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resource-management-options --resource-mgmt-options

Resource management options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resource-move-policy

The resource move policy. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resource-provider-authorization-rules --rp-auth-rules

The resource provider authorization rules. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resource-query-management --resource-query-mgmt

Resource query management options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resource-sub-type

The resource sub type.

Accepted values: AsyncOperation, NotSpecified
--resource-type-common-attribute-management --rt-common-mgmt

Resource type common attribute management. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resource-validation

The resource validation.

Accepted values: NotSpecified, ProfaneWords, ReservedWords
--routing-rule

Routing rule. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--routing-type

The resource routing type.

Accepted values: CascadeExtension, Default, Extension, Failover, Fanout, HostBased, LocationBased, ProxyOnly, Tenant
--service-tree-info --service-tree-infos --service-tree-infos

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.

--sku-link

The sku link.

--soft-delete-ttl

The soft delete time to live.

--sub-state-rule --sub-state-rules --sub-state-rules --subscription-state-rules

The subscription state rules. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --sub-state-rule --sub-state-rules.

--supports-tags

Determines if tags are supported.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--swagger-specification --swagger-specifications --swagger-specifications

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.

--template-deployment-options --tmplt-deploy-opt

The template deployment options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--template-deployment-policy --tmplt-deploy-policy

The template deployment policy. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--throttling-rule --throttling-rules --throttling-rules

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.

--token-auth-config --token-auth-configuration

The token auth configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az providerhub resource-type-registration delete

Delete a resource type.

az providerhub resource-type-registration delete [--ids]
                                                 [--name]
                                                 [--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

--ids

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.

--name --resource-type -n

The resource type.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--provider-namespace

The name of the resource provider hosted within ProviderHub.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--yes -y

Do not prompt for confirmation.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

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

--provider-namespace

The name of the resource provider hosted within ProviderHub.

Optional Parameters

--max-items

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.

--next-token

Token to specify where to start paginating. This is the token value from a previously truncated response.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

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]
                                               [--provider-namespace]
                                               [--subscription]

Examples

resource-type-registration show

az providerhub resource-type-registration show --provider-namespace "{providerNamespace}" --resource-type "extensionresourcetype"

Optional Parameters

--ids

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.

--name --resource-type -n

The resource type.

--provider-namespace

The name of the resource provider hosted within ProviderHub.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az providerhub resource-type-registration update

Update a resource type.

az providerhub resource-type-registration update [--add]
                                                 [--add-resource-list-target-locations {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--additional-options {ProtectedAsyncOperationPolling, ProtectedAsyncOperationPollingAuditOnly}]
                                                 [--allow-empty-role {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--allowed-resource-names]
                                                 [--allowed-templ-actions]
                                                 [--allowed-unauthorized-actions]
                                                 [--api-profiles]
                                                 [--async-op-rt-name]
                                                 [--async-timeout-rules]
                                                 [--auth-mapping]
                                                 [--availability-zone-rule]
                                                 [--capacity-rule]
                                                 [--category {FreeForm, Internal, None, PureProxy}]
                                                 [--check-name-availability-specifications]
                                                 [--common-api-versions]
                                                 [--concurrency-options]
                                                 [--creation-begin]
                                                 [--cross-tenant-token-validation {EnsureSecureValidation, PassthroughInsecureToken}]
                                                 [--dav]
                                                 [--default-api-version]
                                                 [--deletion-policy {CascadeDeleteAll, CascadeDeleteProxyOnlyChildren, NotSpecified}]
                                                 [--disallowed-end-user-operations]
                                                 [--dsts-configuration]
                                                 [--enable-3p-s2s {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--enable-async-operation {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--endpoint]
                                                 [--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-notif-rules]
                                                 [--linked-operation-rules]
                                                 [--logging-rules]
                                                 [--managed-resource-group-configuration]
                                                 [--management]
                                                 [--manifest-link]
                                                 [--marketplace-options]
                                                 [--marketplace-type {AddOn, Bypass, NotSpecified, Store}]
                                                 [--metadata]
                                                 [--name]
                                                 [--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]
                                                 [--policy-execution-type {BypassPolicies, ExecutePolicies, ExpectPartialPutRequests, NotSpecified}]
                                                 [--priv-endpoint-config]
                                                 [--provider-namespace]
                                                 [--quota-rule]
                                                 [--regionality {Global, NotSpecified, Regional}]
                                                 [--remove]
                                                 [--req-features-policy {All, Any}]
                                                 [--required-features]
                                                 [--resource-cache]
                                                 [--resource-graph-config]
                                                 [--resource-management-options]
                                                 [--resource-move-policy]
                                                 [--resource-provider-authorization-rules]
                                                 [--resource-query-management]
                                                 [--resource-sub-type {AsyncOperation, NotSpecified}]
                                                 [--resource-type-common-attribute-management]
                                                 [--resource-validation {NotSpecified, ProfaneWords, ReservedWords}]
                                                 [--routing-rule]
                                                 [--routing-type {CascadeExtension, Default, Extension, Failover, Fanout, HostBased, LocationBased, ProxyOnly, Tenant}]
                                                 [--service-tree-info]
                                                 [--set]
                                                 [--sku-link]
                                                 [--soft-delete-ttl]
                                                 [--sub-state-rule]
                                                 [--subscription]
                                                 [--supports-tags {0, 1, f, false, n, no, t, true, y, yes}]
                                                 [--swagger-specification]
                                                 [--template-deployment-options]
                                                 [--template-deployment-policy]
                                                 [--throttling-rule]
                                                 [--token-auth-config]

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

--add

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>.

--add-resource-list-target-locations --add-target-locations

Add resource list target locations?

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--additional-options

The additional options.

Accepted values: ProtectedAsyncOperationPolling, ProtectedAsyncOperationPollingAuditOnly
--allow-empty-role --allow-empty-role-assignments

Determines if empty role assignments are allowed.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--allowed-resource-names

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--allowed-templ-actions --allowed-template-deployment-reference-actions

Allowed template deployment reference actions. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--allowed-unauthorized-actions --aua

The allowed unauthorized actions. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--api-profiles

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--async-op-rt-name --async-operation-resource-type-name

The async operation resource type name.

--async-timeout-rules

Async timeout rules Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--auth-mapping --auth-mappings --auth-mappings --authorization-action-mappings

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.

--availability-zone-rule

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--capacity-rule

Capacity rule. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--category

The category.

Accepted values: FreeForm, Internal, None, PureProxy
--check-name-availability-specifications --checkname-specs

Name availability checks feature at the platform level. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--common-api-versions

Common API versions for the resource type. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--concurrency-options --resource-concurrency-control-options

The resource concurrency control options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--creation-begin --resource-creation-begin

Extension options for handling the resource creation begin extension request. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--cross-tenant-token-validation --token-validation

The cross tenant token validation.

Accepted values: EnsureSecureValidation, PassthroughInsecureToken
--dav --disallowed-action-verbs

The disallowed action verbs. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--default-api-version

The default API version for the endpoint.

--deletion-policy --resource-deletion-policy

The resource deletion policy.

Accepted values: CascadeDeleteAll, CascadeDeleteProxyOnlyChildren, NotSpecified
--disallowed-end-user-operations --disallowed-ops

The disallowed end user operations. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--dsts-configuration

The DSTS configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--enable-3p-s2s --enable-third-party-s2-s

Indicates whether third party s2s is enabled for this resource type.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--enable-async-operation

Indicates whether the async operation is enabled for this resource type.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--endpoint --endpoints

The resource type endpoints. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --endpoint.

--extended-locations

The extended location options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--force-string

When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--frontdoor-request-mode

The frontdoor request mode.

Accepted values: NotSpecified, UseManifest
--grouping-tag

Grouping tag.

--identity-management

MSI related settings. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--ids

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.

--is-pure-proxy

Indicates whether this is a PureProxy resource type.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--kind

Resource type registration kind. This Metadata is also used by portal/tooling/etc to render different UX experiences for resources of the same type.

Accepted values: Direct, Hybrid, Managed
--legacy-name

The legacy name.

--legacy-names

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--legacy-policy

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--linked-access-check --linked-access-checks --linked-access-checks

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.

--linked-notif-rules --linked-notification-rules

The linked notification rules. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--linked-operation-rules

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--logging-rules

The logging rules. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--managed-resource-group-configuration --managed-rg-config

The managed resource group configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--management

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--manifest-link

Manifest link.

--marketplace-options

Marketplace options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--marketplace-type

The type of marketplace behavior for the resource type.

Accepted values: AddOn, Bypass, NotSpecified, Store
--metadata

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--name --resource-type -n

The resource type.

--no-wait

Do not wait for the long-running operation to finish.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--notifications

The notifications object. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--on-behalf-of-tokens

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--open-api-configuration

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--opt-in-headers

The opt-in headers.

Accepted values: ClientGroupMembership, ClientPrincipalNameEncoded, MSIResourceIdEncoded, ManagementGroupAncestorsEncoded, NotSpecified, PrivateLinkId, PrivateLinkResourceId, PrivateLinkVnetTrafficTag, ResourceGroupLocation, SignedAuxiliaryTokens, SignedUserToken, UnboundedClientGroupMembership
--opt-out-headers

The opt-out headers.

Accepted values: NotSpecified, SystemDataCreatedByLastModifiedBy
--override-actions --subscription-state-override-actions

The subscription state override actions. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--policy-execution-type

The policy execution type.

Accepted values: BypassPolicies, ExecutePolicies, ExpectPartialPutRequests, NotSpecified
--priv-endpoint-config --private-endpoint-configuration

The private endpoint config. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--provider-namespace

The name of the resource provider hosted within ProviderHub.

--quota-rule

Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--regionality

The regionality of the resource type. Allowed values: Global, NotSpecified, Regional.

Accepted values: Global, NotSpecified, Regional
--remove

Remove a property or an element from a list. Example: --remove property.list OR --remove propertyToRemove.

--req-features-policy --required-features-policy

The accepted values are "Any" or "All".

Accepted values: All, Any
--required-features

The required features. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resource-cache

Resource cache options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resource-graph-config --resource-graph-configuration

The resource graph configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resource-management-options --resource-mgmt-options

Resource management options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resource-move-policy

The resource move policy. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resource-provider-authorization-rules --rp-auth-rules

The resource provider authorization rules. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resource-query-management --resource-query-mgmt

Resource query management options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resource-sub-type

The resource sub type.

Accepted values: AsyncOperation, NotSpecified
--resource-type-common-attribute-management --rt-common-mgmt

Resource type common attribute management. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--resource-validation

The resource validation.

Accepted values: NotSpecified, ProfaneWords, ReservedWords
--routing-rule

Routing rule. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--routing-type

The resource routing type.

Accepted values: CascadeExtension, Default, Extension, Failover, Fanout, HostBased, LocationBased, ProxyOnly, Tenant
--service-tree-info --service-tree-infos --service-tree-infos

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.

--set

Update an object by specifying a property path and value to set. Example: --set property1.property2=.

--sku-link

The sku link.

--soft-delete-ttl

The soft delete time to live.

--sub-state-rule --sub-state-rules --sub-state-rules --subscription-state-rules

The subscription state rules. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --sub-state-rule --sub-state-rules.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--supports-tags

Determines if tags are supported.

Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--swagger-specification --swagger-specifications --swagger-specifications

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.

--template-deployment-options --tmplt-deploy-opt

The template deployment options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--template-deployment-policy --tmplt-deploy-policy

The template deployment policy. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

--throttling-rule --throttling-rules --throttling-rules

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.

--token-auth-config --token-auth-configuration

The token auth configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

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]
                                               [--provider-namespace]
                                               [--subscription]
                                               [--timeout]
                                               [--updated]

Optional Parameters

--created

Wait until created with 'provisioningState' at 'Succeeded'.

Default value: False
--custom

Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].

--deleted

Wait until deleted.

Default value: False
--exists

Wait until the resource exists.

Default value: False
--ids

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.

--interval

Polling interval in seconds.

Default value: 30
--name --resource-type -n

The resource type.

--provider-namespace

The name of the resource provider hosted within ProviderHub.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--timeout

Maximum wait in seconds.

Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.