az providerhub provider-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 provider-registration command. Learn more about extensions.

Manage provider registration with providerhub.

Commands

Name	Description	Type	Status
az providerhub provider-registration create	Create the provider registration.	Extension	GA
az providerhub provider-registration delete	Delete a provider registration.	Extension	GA
az providerhub provider-registration generate-operation	Generates the operations api for the given provider.	Extension	GA
az providerhub provider-registration list	List the list of the provider registrations in the subscription.	Extension	GA
az providerhub provider-registration resource-action	Manage resource action with providerhub.	Extension	GA
az providerhub provider-registration resource-action delete-resource	Deletes resources.	Extension	GA
az providerhub provider-registration show	Get the provider registration details.	Extension	GA
az providerhub provider-registration update	Update the provider registration.	Extension	GA
az providerhub provider-registration wait	Place the CLI in a waiting state until a condition is met.	Extension	GA

az providerhub provider-registration create

Create the provider registration.

az providerhub provider-registration create --name --provider-namespace
                                            [--authorization-owners]
                                            [--canary-manifest-owners]
                                            [--capabilities --capabilities --capability]
                                            [--cross-tenant-token-validation --token-validation {EnsureSecureValidation, PassthroughInsecureToken}]
                                            [--custom-manifest-vers --custom-manifest-version]
                                            [--dsts-configuration]
                                            [--enable-linked-notif --enable-tenant-linked-notification {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--error-response-message-options --message-options]
                                            [--expedited-rollout-metadata --rollout-metadata]
                                            [--expedited-rollout-submitters --rollout-submitters]
                                            [--global-notif-endpoints --global-notification-endpoints]
                                            [--incident-contact-email]
                                            [--incident-routing-service --incident-service]
                                            [--incident-routing-team --incident-team]
                                            [--kind {Direct, Hybrid, Managed}]
                                            [--legacy-namespace]
                                            [--legacy-registrations]
                                            [--linked-notif-rules --linked-notification-rules]
                                            [--management-group-global-notification-endpoints --mg-notif-endpoints]
                                            [--manifest-owner --manifest-owners]
                                            [--metadata]
                                            [--namespace]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--notification-options {EmitSpendingLimit, None, NotSpecified}]
                                            [--notification-settings]
                                            [--notifications]
                                            [--opt-in-headers {ClientGroupMembership, ClientPrincipalNameEncoded, MSIResourceIdEncoded, ManagementGroupAncestorsEncoded, NotSpecified, PrivateLinkId, PrivateLinkResourceId, PrivateLinkVnetTrafficTag, ResourceGroupLocation, SignedAuxiliaryTokens, SignedUserToken, UnboundedClientGroupMembership}]
                                            [--opt-out-headers {NotSpecified, SystemDataCreatedByLastModifiedBy}]
                                            [--optional-features]
                                            [--override-actions --subscription-state-override-actions]
                                            [--pc-code]
                                            [--pc-program-id --profit-center-program-id]
                                            [--private-resource-provider-configuration --private-rp-config]
                                            [--provider-auth --provider-authorizations --provider-authorizations --provider-authz]
                                            [--provider-authentication --provider-authn]
                                            [--provider-hub-metadata]
                                            [--provider-type]
                                            [--provider-version]
                                            [--req-features-policy --required-features-policy {All, Any}]
                                            [--required-features]
                                            [--resc-hydration-accts --resource-hydration-accounts]
                                            [--resource-access-policy {AcisActionAllowed, AcisReadAllowed, NotSpecified}]
                                            [--resource-access-roles]
                                            [--resource-group-lock-option-during-move --rg-lock-option]
                                            [--resource-provider-authorization-rules --rp-auth-rules]
                                            [--response-options]
                                            [--schema-owner --schema-owners --schema-owners]
                                            [--service-name]
                                            [--service-tree-info --service-tree-infos --service-tree-infos]
                                            [--services]
                                            [--soft-delete-ttl]
                                            [--template-deployment-options --tmplt-deploy-opt]
                                            [--token-auth-config --token-auth-configuration]

Examples

provider-registration create

az providerhub provider-registration create --token-auth-configuration authentication-scheme="PoP" signed-request-scope="ResourceUri" --service-tree-infos service-id="d1b7d8ba-05e2-48e6-90d6-d781b99c6e69" component-id="d1b7d8ba-05e2-48e6-90d6-d781b99c6e69" --capabilities effect="Allow" quota-id="CSP_2015-05-01" --capabilities effect="Allow" quota-id="CSP_MG_2017-12-01" --manifest-owners "SPARTA-PlatformServiceAdministrator" --incident-contact-email "rpaascore@microsoft.com" --incident-routing-service "Resource Provider Service as a Service" --incident-routing-team "RPaaS" --provider-version "2.0" --provider-namespace "{providerNamespace}" --metadata "BypassManifestValidation":true

Required Parameters

--name --provider-namespace -n

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.

--authorization-owners

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

Property	Value
Parameter group:	Management Arguments

--canary-manifest-owners

List of manifest owners for canary Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Management Arguments

--capabilities --capabilities --capability

This allows a restrictive subscription type to have access to register and use the Resource Provider. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --capability --capabilities.

Property	Value
Parameter group:	Properties Arguments

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

The cross tenant token validation.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	EnsureSecureValidation, PassthroughInsecureToken

--custom-manifest-vers --custom-manifest-version

Custom manifest version.

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-linked-notif --enable-tenant-linked-notification

The enable tenant linked notification.

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

--error-response-message-options --message-options

Options for error response messages. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Management Arguments

--expedited-rollout-metadata --rollout-metadata

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

Property	Value
Parameter group:	Management Arguments

--expedited-rollout-submitters --rollout-submitters

List of expedited rollout submitters. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Management Arguments

--global-notif-endpoints --global-notification-endpoints

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

Property	Value
Parameter group:	Properties Arguments

--incident-contact-email

The email address of contacts for incidents related to the RP.

Property	Value
Parameter group:	Management Arguments

--incident-routing-service --incident-service

The service in IcM when creating or transferring incidents to the RP.

Property	Value
Parameter group:	Management Arguments

--incident-routing-team --incident-team

The team in IcM when creating or transferring incidents to the RP.

Property	Value
Parameter group:	Management Arguments

--kind

Provider 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-namespace

Legacy namespace.

Property	Value
Parameter group:	Properties Arguments

--legacy-registrations

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

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

--management-group-global-notification-endpoints --mg-notif-endpoints

Management groups global notification endpoints. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--manifest-owner --manifest-owners

Specifies an array of required ACIS claims to modify the resource provider's manifest content via ACIS. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --manifest-owner.

Property	Value
Parameter group:	Management Arguments

--metadata

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

Property	Value
Parameter group:	Properties Arguments

--namespace

The name of the resource provider hosted within ProviderHub.

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

--notification-options

Notification options.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	EmitSpendingLimit, None, NotSpecified

--notification-settings

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

Property	Value
Parameter group:	Properties Arguments

--notifications

The notifications object. 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

--optional-features

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

Property	Value
Parameter group:	Properties Arguments

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

--pc-code

The profit center code for the subscription.

Property	Value
Parameter group:	Management Arguments

--pc-program-id --profit-center-program-id

The profit center program id for the subscription.

Property	Value
Parameter group:	Management Arguments

--private-resource-provider-configuration --private-rp-config

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

Property	Value
Parameter group:	Properties Arguments

--provider-auth --provider-authorizations --provider-authorizations --provider-authz

The resource provider authorizations. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --provider-auth --provider-authz --provider-authorizations.

Property	Value
Parameter group:	Properties Arguments

--provider-authentication --provider-authn

Used to set alternative audiences or resources that ARM should accept from the token while authenticating requests for the provider. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--provider-hub-metadata

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

Property	Value
Parameter group:	Properties Arguments

--provider-type

The provider type. Provider type options are: AuthorizationFree, External, Hidden, Internal, LegacyRegistrationRequired, NotSpecified, RegistrationFree, TenantOnly. Select multiple with comma separated string.

Property	Value
Parameter group:	Properties Arguments

--provider-version

The provider version.

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

--resc-hydration-accts --resource-hydration-accounts

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

Property	Value
Parameter group:	Properties Arguments

--resource-access-policy

The resource access policy.

Property	Value
Parameter group:	Management Arguments
Accepted values:	AcisActionAllowed, AcisReadAllowed, NotSpecified

--resource-access-roles

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

Property	Value
Parameter group:	Management Arguments

--resource-group-lock-option-during-move --rg-lock-option

Resource group lock option during move. 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

--response-options

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

Property	Value
Parameter group:	Properties Arguments

--schema-owner --schema-owners --schema-owners

Specifies an array of needed ACIS claims to modify the resource provider schema via ACIS. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --schema-owner --schema-owners.

Property	Value
Parameter group:	Management Arguments

--service-name

The service name.

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:	Management Arguments

--services

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

Property	Value
Parameter group:	Properties Arguments

--soft-delete-ttl

The soft delete time to live.

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

--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 provider-registration delete

Delete a provider registration.

az providerhub provider-registration delete [--ids]
                                            [--name --provider-namespace]
                                            [--subscription]
                                            [--yes]

Examples

provider-registration delete

az providerhub provider-registration delete -y --provider-namespace "{providerNamespace}"

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 --provider-namespace -n

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 provider-registration generate-operation

Generates the operations api for the given provider.

az providerhub provider-registration generate-operation [--ids]
                                                        [--provider-namespace]
                                                        [--subscription]

Examples

provider-registration generate-operation

az providerhub provider-registration generate-operation --provider-namespace "{providerNamespace}"

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

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 provider-registration list

List the list of the provider registrations in the subscription.

az providerhub provider-registration list [--max-items]
                                          [--next-token]

Examples

provider-registration list

az providerhub provider-registration list

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 provider-registration show

Get the provider registration details.

az providerhub provider-registration show [--ids]
                                          [--name --provider-namespace]
                                          [--subscription]

Examples

provider-registration show

az providerhub provider-registration show --provider-namespace "{providerNamespace}"

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

Property	Value
Parameter group:	Resource Id Arguments

--name --provider-namespace -n

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 provider-registration update

Update the provider registration.

az providerhub provider-registration update [--add]
                                            [--authorization-owners]
                                            [--canary-manifest-owners]
                                            [--capabilities --capabilities --capability]
                                            [--cross-tenant-token-validation --token-validation {EnsureSecureValidation, PassthroughInsecureToken}]
                                            [--custom-manifest-vers --custom-manifest-version]
                                            [--dsts-configuration]
                                            [--enable-linked-notif --enable-tenant-linked-notification {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--error-response-message-options --message-options]
                                            [--expedited-rollout-metadata --rollout-metadata]
                                            [--expedited-rollout-submitters --rollout-submitters]
                                            [--force-string {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--global-notif-endpoints --global-notification-endpoints]
                                            [--ids]
                                            [--incident-contact-email]
                                            [--incident-routing-service --incident-service]
                                            [--incident-routing-team --incident-team]
                                            [--kind {Direct, Hybrid, Managed}]
                                            [--legacy-namespace]
                                            [--legacy-registrations]
                                            [--linked-notif-rules --linked-notification-rules]
                                            [--management-group-global-notification-endpoints --mg-notif-endpoints]
                                            [--manifest-owner --manifest-owners]
                                            [--metadata]
                                            [--name --provider-namespace]
                                            [--namespace]
                                            [--no-wait {0, 1, f, false, n, no, t, true, y, yes}]
                                            [--notification-options {EmitSpendingLimit, None, NotSpecified}]
                                            [--notification-settings]
                                            [--notifications]
                                            [--opt-in-headers {ClientGroupMembership, ClientPrincipalNameEncoded, MSIResourceIdEncoded, ManagementGroupAncestorsEncoded, NotSpecified, PrivateLinkId, PrivateLinkResourceId, PrivateLinkVnetTrafficTag, ResourceGroupLocation, SignedAuxiliaryTokens, SignedUserToken, UnboundedClientGroupMembership}]
                                            [--opt-out-headers {NotSpecified, SystemDataCreatedByLastModifiedBy}]
                                            [--optional-features]
                                            [--override-actions --subscription-state-override-actions]
                                            [--pc-code]
                                            [--pc-program-id --profit-center-program-id]
                                            [--private-resource-provider-configuration --private-rp-config]
                                            [--provider-auth --provider-authorizations --provider-authorizations --provider-authz]
                                            [--provider-authentication --provider-authn]
                                            [--provider-hub-metadata]
                                            [--provider-type]
                                            [--provider-version]
                                            [--remove]
                                            [--req-features-policy --required-features-policy {All, Any}]
                                            [--required-features]
                                            [--resc-hydration-accts --resource-hydration-accounts]
                                            [--resource-access-policy {AcisActionAllowed, AcisReadAllowed, NotSpecified}]
                                            [--resource-access-roles]
                                            [--resource-group-lock-option-during-move --rg-lock-option]
                                            [--resource-provider-authorization-rules --rp-auth-rules]
                                            [--response-options]
                                            [--schema-owner --schema-owners --schema-owners]
                                            [--service-name]
                                            [--service-tree-info --service-tree-infos --service-tree-infos]
                                            [--services]
                                            [--set]
                                            [--soft-delete-ttl]
                                            [--subscription]
                                            [--template-deployment-options --tmplt-deploy-opt]
                                            [--token-auth-config --token-auth-configuration]

Examples

provider-registration update

az providerhub provider-registration update --token-auth-configuration authentication-scheme="PoP" signed-request-scope="ResourceUri" --service-tree-infos service-id="d1b7d8ba-05e2-48e6-90d6-d781b99c6e69" component-id="d1b7d8ba-05e2-48e6-90d6-d781b99c6e69" --capabilities effect="Allow" quota-id="CSP_2015-05-01" --capabilities effect="Allow" quota-id="CSP_MG_2017-12-01" --manifest-owners "SPARTA-PlatformServiceAdministrator" --incident-contact-email "rpaascore@microsoft.com" --incident-routing-service "Resource Provider Service as a Service" --incident-routing-team "RPaaS" --provider-version "2.0" --provider-namespace "{providerNamespace}" --metadata "BypassManifestValidation":true

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

--authorization-owners

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

Property	Value
Parameter group:	Management Arguments

--canary-manifest-owners

List of manifest owners for canary. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Management Arguments

--capabilities --capabilities --capability

Property	Value
Parameter group:	Properties Arguments

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

The cross tenant token validation.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	EnsureSecureValidation, PassthroughInsecureToken

--custom-manifest-vers --custom-manifest-version

Custom manifest version.

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-linked-notif --enable-tenant-linked-notification

The enable tenant linked notification.

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

--error-response-message-options --message-options

Options for error response messages. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Management Arguments

--expedited-rollout-metadata --rollout-metadata

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

Property	Value
Parameter group:	Management Arguments

--expedited-rollout-submitters --rollout-submitters

List of expedited rollout submitters. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Management 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

--global-notif-endpoints --global-notification-endpoints

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

Property	Value
Parameter group:	Properties Arguments

--ids

Property	Value
Parameter group:	Resource Id Arguments

--incident-contact-email

The email address of contacts for incidents related to the RP.

Property	Value
Parameter group:	Management Arguments

--incident-routing-service --incident-service

The service in IcM when creating or transferring incidents to the RP.

Property	Value
Parameter group:	Management Arguments

--incident-routing-team --incident-team

The team in IcM when creating or transferring incidents to the RP.

Property	Value
Parameter group:	Management Arguments

--kind

Provider 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-namespace

Legacy namespace.

Property	Value
Parameter group:	Properties Arguments

--legacy-registrations

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

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

--management-group-global-notification-endpoints --mg-notif-endpoints

Management groups global notification endpoints. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.

Property	Value
Parameter group:	Properties Arguments

--manifest-owner --manifest-owners

Property	Value
Parameter group:	Management Arguments

--metadata

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

Property	Value
Parameter group:	Properties Arguments

--name --provider-namespace -n

The name of the resource provider hosted within ProviderHub.

Property	Value
Parameter group:	Resource Id Arguments

--namespace

The name of the resource provider hosted within ProviderHub.

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

--notification-options

Notification options.

Property	Value
Parameter group:	Properties Arguments
Accepted values:	EmitSpendingLimit, None, NotSpecified

--notification-settings

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

Property	Value
Parameter group:	Properties Arguments

--notifications

The notifications object. 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

--optional-features

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

Property	Value
Parameter group:	Properties Arguments

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

--pc-code

The profit center code for the subscription.

Property	Value
Parameter group:	Management Arguments

--pc-program-id --profit-center-program-id

The profit center program id for the subscription.

Property	Value
Parameter group:	Management Arguments

--private-resource-provider-configuration --private-rp-config

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

Property	Value
Parameter group:	Properties Arguments

--provider-auth --provider-authorizations --provider-authorizations --provider-authz

The resource provider authorizations. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --provider-auth --provider-authz --provider-authorizations.

Property	Value
Parameter group:	Properties Arguments

--provider-authentication --provider-authn

Property	Value
Parameter group:	Properties Arguments

--provider-hub-metadata

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

Property	Value
Parameter group:	Properties Arguments

--provider-type

Property	Value
Parameter group:	Properties Arguments

--provider-version

The provider version.

Property	Value
Parameter group:	Properties Arguments

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

--resc-hydration-accts --resource-hydration-accounts

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

Property	Value
Parameter group:	Properties Arguments

--resource-access-policy

The resource access policy.

Property	Value
Parameter group:	Management Arguments
Accepted values:	AcisActionAllowed, AcisReadAllowed, NotSpecified

--resource-access-roles

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

Property	Value
Parameter group:	Management Arguments

--resource-group-lock-option-during-move --rg-lock-option

Resource group lock option during move. 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

--response-options

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

Property	Value
Parameter group:	Properties Arguments

--schema-owner --schema-owners --schema-owners

Property	Value
Parameter group:	Management Arguments

--service-name

The service name.

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:	Management Arguments

--services

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

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

--soft-delete-ttl

The soft delete time to live.

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

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

--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 provider-registration wait

Place the CLI in a waiting state until a condition is met.

az providerhub provider-registration wait [--created]
                                          [--custom]
                                          [--deleted]
                                          [--exists]
                                          [--ids]
                                          [--interval]
                                          [--name --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

Property	Value
Parameter group:	Resource Id Arguments

--interval

Polling interval in seconds.

Property	Value
Parameter group:	Wait Condition Arguments
Default value:	30

--name --provider-namespace -n

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

Feedback

Was this page helpful?

Share via

az providerhub provider-registration

Commands

az providerhub provider-registration create

Examples

Required Parameters

Optional Parameters

az providerhub provider-registration delete

Examples

Optional Parameters

az providerhub provider-registration generate-operation

Examples

Optional Parameters

az providerhub provider-registration list

Examples

Optional Parameters

az providerhub provider-registration show

Examples

Optional Parameters

az providerhub provider-registration update

Examples

Optional Parameters

az providerhub provider-registration wait

Optional Parameters

Feedback