Share via


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

--name --resource-type -n

The resource type.

--provider-namespace

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 --add-target-locations

Add resource list target locations?

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--additional-options

The additional options.

Property Value
Parameter group: Properties Arguments
Accepted values: ProtectedAsyncOperationPolling, ProtectedAsyncOperationPollingAuditOnly
--allow-empty-role --allow-empty-role-assignments

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
--allowed-resource-names

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

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Properties Arguments
--allowed-unauthorized-actions --aua

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

Property Value
Parameter group: Properties Arguments
--api-profiles

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

Property Value
Parameter group: Properties Arguments
--async-op-rt-name --async-operation-resource-type-name

The async operation resource type name.

Property Value
Parameter group: Properties Arguments
--async-timeout-rules

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

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Properties Arguments
--availability-zone-rule

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

Property Value
Parameter group: Properties Arguments
--capacity-rule

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

Property Value
Parameter group: Properties Arguments
--category

The category.

Property Value
Parameter group: Properties Arguments
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.

Property Value
Parameter group: Properties Arguments
--common-api-versions

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
--concurrency-options --resource-concurrency-control-options

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

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: ExtensionOptions Arguments
--cross-tenant-token-validation --token-validation

The cross tenant token validation.

Property Value
Parameter group: Properties Arguments
Accepted values: EnsureSecureValidation, PassthroughInsecureToken
--dav --disallowed-action-verbs

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

Property Value
Parameter group: Properties Arguments
--default-api-version

The default API version for the endpoint.

Property Value
Parameter group: Properties Arguments
--deletion-policy --resource-deletion-policy

The resource deletion policy.

Property Value
Parameter group: Properties Arguments
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.

Property Value
Parameter group: Properties Arguments
--dsts-configuration

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

Property Value
Parameter group: Properties Arguments
--enable-3p-s2s --enable-third-party-s2-s

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
--enable-async-operation

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
--endpoint --endpoints

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

Property Value
Parameter group: Properties Arguments
--frontdoor-request-mode

The frontdoor request mode.

Property Value
Parameter group: Properties Arguments
Accepted values: NotSpecified, UseManifest
--grouping-tag

Grouping tag.

Property Value
Parameter group: Properties Arguments
--identity-management

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

Property Value
Parameter group: Properties Arguments
--is-pure-proxy

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

Property Value
Parameter group: Properties Arguments
Default value: Managed
Accepted values: Direct, Hybrid, Managed
--legacy-name

The legacy name.

Property Value
Parameter group: Properties Arguments
--legacy-names

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

Property Value
Parameter group: Properties Arguments
--legacy-policy

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

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Properties Arguments
--linked-notif-rules --linked-notification-rules

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

Property Value
Parameter group: Properties Arguments
--linked-operation-rules

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

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Properties Arguments
--managed-resource-group-configuration --managed-rg-config

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

Property Value
Parameter group: Properties Arguments
--management

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

Property Value
Parameter group: Properties Arguments
--manifest-link

Manifest link.

Property Value
Parameter group: Properties Arguments
--marketplace-options

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

Property Value
Parameter group: Properties Arguments
--marketplace-type

The type of marketplace behavior for the resource type.

Property Value
Parameter group: Properties Arguments
Accepted values: AddOn, Bypass, NotSpecified, Store
--metadata

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

Property Value
Parameter group: Properties Arguments
--no-wait

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

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

Property Value
Parameter group: Properties Arguments
--on-behalf-of-tokens

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

Property Value
Parameter group: Properties Arguments
--open-api-configuration

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

Property Value
Parameter group: Properties Arguments
--opt-in-headers

The opt-in headers.

Property Value
Parameter group: RequestHeaderOptions Arguments
Accepted values: ClientGroupMembership, ClientPrincipalNameEncoded, MSIResourceIdEncoded, ManagementGroupAncestorsEncoded, NotSpecified, PrivateLinkId, PrivateLinkResourceId, PrivateLinkVnetTrafficTag, ResourceGroupLocation, SignedAuxiliaryTokens, SignedUserToken, UnboundedClientGroupMembership
--opt-out-headers

The opt-out headers.

Property Value
Parameter group: RequestHeaderOptions Arguments
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.

Property Value
Parameter group: SubscriptionLifecycleNotificationSpecifications Arguments
--policy-execution-type

The policy execution type.

Property Value
Parameter group: Properties Arguments
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.

Property Value
Parameter group: Properties Arguments
--quota-rule

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

Property Value
Parameter group: Properties Arguments
--regionality

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

Property Value
Parameter group: Properties Arguments
Accepted values: Global, NotSpecified, Regional
--req-features-policy --required-features-policy

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

Property Value
Parameter group: FeaturesRule Arguments
Accepted values: All, Any
--required-features

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

Property Value
Parameter group: Properties Arguments
--resource-cache

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

Property Value
Parameter group: Properties Arguments
--resource-graph-config --resource-graph-configuration

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 --resource-mgmt-options

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

Property Value
Parameter group: Properties Arguments
--resource-move-policy

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

Property Value
Parameter group: Properties Arguments
--resource-provider-authorization-rules --rp-auth-rules

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 --resource-query-mgmt

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

Property Value
Parameter group: Properties Arguments
--resource-sub-type

The resource sub type.

Property Value
Parameter group: Properties Arguments
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.

Property Value
Parameter group: Properties Arguments
--resource-validation

The resource validation.

Property Value
Parameter group: Properties Arguments
Accepted values: NotSpecified, ProfaneWords, ReservedWords
--routing-rule

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

Property Value
Parameter group: Properties Arguments
--routing-type

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

Property Value
Parameter group: Properties Arguments
--sku-link

The sku link.

Property Value
Parameter group: Properties Arguments
--soft-delete-ttl

The soft delete time to live.

Property Value
Parameter group: SubscriptionLifecycleNotificationSpecifications Arguments
--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.

Property Value
Parameter group: Properties Arguments
--supports-tags

Determines if tags are supported.

Property Value
Parameter group: Properties Arguments
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.

Property Value
Parameter group: Properties Arguments
--template-deployment-options --tmplt-deploy-opt

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

Property Value
Parameter group: Properties Arguments
--template-deployment-policy --tmplt-deploy-policy

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

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Properties Arguments
--token-auth-config --token-auth-configuration

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

Property Value
Parameter group: Properties Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

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.

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

Property Value
Parameter group: Resource Id Arguments
--name --resource-type -n

The resource type.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

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

The name of the resource provider hosted within ProviderHub.

Property Value
Parameter group: Resource Id Arguments
--subscription

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
--yes -y

Do not prompt for confirmation.

Property Value
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

--provider-namespace

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.

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

Property Value
Parameter group: Pagination Arguments
--next-token

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

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--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.

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.

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

Property Value
Parameter group: Resource Id Arguments
--name --resource-type -n

The resource type.

Property Value
Parameter group: Resource Id Arguments
--provider-namespace

The name of the resource provider hosted within ProviderHub.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

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 --add-target-locations

Add resource list target locations?

Property Value
Parameter group: Properties Arguments
Accepted values: 0, 1, f, false, n, no, t, true, y, yes
--additional-options

The additional options.

Property Value
Parameter group: Properties Arguments
Accepted values: ProtectedAsyncOperationPolling, ProtectedAsyncOperationPollingAuditOnly
--allow-empty-role --allow-empty-role-assignments

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
--allowed-resource-names

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

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Properties Arguments
--allowed-unauthorized-actions --aua

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

Property Value
Parameter group: Properties Arguments
--api-profiles

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

Property Value
Parameter group: Properties Arguments
--async-op-rt-name --async-operation-resource-type-name

The async operation resource type name.

Property Value
Parameter group: Properties Arguments
--async-timeout-rules

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

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Properties Arguments
--availability-zone-rule

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

Property Value
Parameter group: Properties Arguments
--capacity-rule

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

Property Value
Parameter group: Properties Arguments
--category

The category.

Property Value
Parameter group: Properties Arguments
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.

Property Value
Parameter group: Properties Arguments
--common-api-versions

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
--concurrency-options --resource-concurrency-control-options

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

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: ExtensionOptions Arguments
--cross-tenant-token-validation --token-validation

The cross tenant token validation.

Property Value
Parameter group: Properties Arguments
Accepted values: EnsureSecureValidation, PassthroughInsecureToken
--dav --disallowed-action-verbs

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

Property Value
Parameter group: Properties Arguments
--default-api-version

The default API version for the endpoint.

Property Value
Parameter group: Properties Arguments
--deletion-policy --resource-deletion-policy

The resource deletion policy.

Property Value
Parameter group: Properties Arguments
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.

Property Value
Parameter group: Properties Arguments
--dsts-configuration

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

Property Value
Parameter group: Properties Arguments
--enable-3p-s2s --enable-third-party-s2-s

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
--enable-async-operation

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
--endpoint --endpoints

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
--extended-locations

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

Property Value
Parameter group: Properties Arguments
--force-string

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
--frontdoor-request-mode

The frontdoor request mode.

Property Value
Parameter group: Properties Arguments
Accepted values: NotSpecified, UseManifest
--grouping-tag

Grouping tag.

Property Value
Parameter group: Properties Arguments
--identity-management

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

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Resource Id Arguments
--is-pure-proxy

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

Property Value
Parameter group: Properties Arguments
Accepted values: Direct, Hybrid, Managed
--legacy-name

The legacy name.

Property Value
Parameter group: Properties Arguments
--legacy-names

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

Property Value
Parameter group: Properties Arguments
--legacy-policy

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

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Properties Arguments
--linked-notif-rules --linked-notification-rules

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

Property Value
Parameter group: Properties Arguments
--linked-operation-rules

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

Property Value
Parameter group: Properties Arguments
--logging-rules

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

Property Value
Parameter group: Properties Arguments
--managed-resource-group-configuration --managed-rg-config

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

Property Value
Parameter group: Properties Arguments
--management

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

Property Value
Parameter group: Properties Arguments
--manifest-link

Manifest link.

Property Value
Parameter group: Properties Arguments
--marketplace-options

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

Property Value
Parameter group: Properties Arguments
--marketplace-type

The type of marketplace behavior for the resource type.

Property Value
Parameter group: Properties Arguments
Accepted values: AddOn, Bypass, NotSpecified, Store
--metadata

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

Property Value
Parameter group: Properties Arguments
--name --resource-type -n

The resource type.

Property Value
Parameter group: Resource Id Arguments
--no-wait

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

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

Property Value
Parameter group: Properties Arguments
--on-behalf-of-tokens

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

Property Value
Parameter group: Properties Arguments
--open-api-configuration

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

Property Value
Parameter group: Properties Arguments
--opt-in-headers

The opt-in headers.

Property Value
Parameter group: RequestHeaderOptions Arguments
Accepted values: ClientGroupMembership, ClientPrincipalNameEncoded, MSIResourceIdEncoded, ManagementGroupAncestorsEncoded, NotSpecified, PrivateLinkId, PrivateLinkResourceId, PrivateLinkVnetTrafficTag, ResourceGroupLocation, SignedAuxiliaryTokens, SignedUserToken, UnboundedClientGroupMembership
--opt-out-headers

The opt-out headers.

Property Value
Parameter group: RequestHeaderOptions Arguments
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.

Property Value
Parameter group: SubscriptionLifecycleNotificationSpecifications Arguments
--policy-execution-type

The policy execution type.

Property Value
Parameter group: Properties Arguments
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.

Property Value
Parameter group: Properties Arguments
--provider-namespace

The name of the resource provider hosted within ProviderHub.

Property Value
Parameter group: Resource Id Arguments
--quota-rule

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

Property Value
Parameter group: Properties Arguments
--regionality

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

Property Value
Parameter group: Properties Arguments
Accepted values: Global, NotSpecified, Regional
--remove

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

Property Value
Parameter group: Generic Update Arguments
--req-features-policy --required-features-policy

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

Property Value
Parameter group: FeaturesRule Arguments
Accepted values: All, Any
--required-features

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

Property Value
Parameter group: Properties Arguments
--resource-cache

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

Property Value
Parameter group: Properties Arguments
--resource-graph-config --resource-graph-configuration

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 --resource-mgmt-options

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

Property Value
Parameter group: Properties Arguments
--resource-move-policy

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

Property Value
Parameter group: Properties Arguments
--resource-provider-authorization-rules --rp-auth-rules

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 --resource-query-mgmt

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

Property Value
Parameter group: Properties Arguments
--resource-sub-type

The resource sub type.

Property Value
Parameter group: Properties Arguments
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.

Property Value
Parameter group: Properties Arguments
--resource-validation

The resource validation.

Property Value
Parameter group: Properties Arguments
Accepted values: NotSpecified, ProfaneWords, ReservedWords
--routing-rule

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

Property Value
Parameter group: Properties Arguments
--routing-type

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

Property Value
Parameter group: Properties Arguments
--set

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

Property Value
Parameter group: Generic Update Arguments
--sku-link

The sku link.

Property Value
Parameter group: Properties Arguments
--soft-delete-ttl

The soft delete time to live.

Property Value
Parameter group: SubscriptionLifecycleNotificationSpecifications Arguments
--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.

Property Value
Parameter group: Properties Arguments
--subscription

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
--supports-tags

Determines if tags are supported.

Property Value
Parameter group: Properties Arguments
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.

Property Value
Parameter group: Properties Arguments
--template-deployment-options --tmplt-deploy-opt

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

Property Value
Parameter group: Properties Arguments
--template-deployment-policy --tmplt-deploy-policy

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

Property Value
Parameter group: Properties Arguments
--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.

Property Value
Parameter group: Properties Arguments
--token-auth-config --token-auth-configuration

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

Property Value
Parameter group: Properties Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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.

--created

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

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--custom

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

Wait until deleted.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
--exists

Wait until the resource exists.

Property Value
Parameter group: Wait Condition Arguments
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.

Property Value
Parameter group: Resource Id Arguments
--interval

Polling interval in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 30
--name --resource-type -n

The resource type.

Property Value
Parameter group: Resource Id Arguments
--provider-namespace

The name of the resource provider hosted within ProviderHub.

Property Value
Parameter group: Resource Id Arguments
--subscription

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

Maximum wait in seconds.

Property Value
Parameter group: Wait Condition Arguments
Default value: 3600
--updated

Wait until updated with provisioningState at 'Succeeded'.

Property Value
Parameter group: Wait Condition Arguments
Default value: False
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

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

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

--verbose

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

Property Value
Default value: False