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
[--authorization-owners]
[--canary-manifest-owners]
[--capabilities]
[--cross-tenant-token-validation {EnsureSecureValidation, PassthroughInsecureToken}]
[--custom-manifest-vers]
[--dsts-configuration]
[--enable-linked-notif {0, 1, f, false, n, no, t, true, y, yes}]
[--error-response-message-options]
[--expedited-rollout-metadata]
[--expedited-rollout-submitters]
[--global-notif-endpoints]
[--incident-contact-email]
[--incident-routing-service]
[--incident-routing-team]
[--kind {Direct, Hybrid, Managed}]
[--legacy-namespace]
[--legacy-registrations]
[--linked-notif-rules]
[--management-group-global-notification-endpoints]
[--manifest-owner]
[--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]
[--pc-code]
[--pc-program-id]
[--private-resource-provider-configuration]
[--provider-auth]
[--provider-authentication]
[--provider-hub-metadata]
[--provider-type {AuthorizationFree, External, Hidden, Internal, LegacyRegistrationRequired, NotSpecified, RegistrationFree, TenantOnly}]
[--provider-version]
[--req-features-policy {All, Any}]
[--required-features]
[--resc-hydration-accts]
[--resource-access-policy {AcisActionAllowed, AcisReadAllowed, NotSpecified}]
[--resource-access-roles]
[--resource-group-lock-option-during-move]
[--resource-provider-authorization-rules]
[--response-options]
[--schema-owner]
[--service-name]
[--service-tree-info]
[--services]
[--soft-delete-ttl]
[--template-deployment-options]
[--token-auth-config]
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
The name of the resource provider hosted within ProviderHub.
Optional Parameters
The authorization owners. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
List of manifest owners for canary Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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
.
The cross tenant token validation.
Custom manifest version.
The DSTS configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The enable tenant linked notification.
Options for error response messages. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Metadata for expedited rollout. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
List of expedited rollout submitters. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The global notification endpoints. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The email address of contacts for incidents related to the RP.
The service in IcM when creating or transferring incidents to the RP.
The team in IcM when creating or transferring incidents to the RP.
Provider registration kind. This Metadata is also used by portal/tooling/etc to render different UX experiences for resources of the same type.
Legacy namespace.
Legacy registrations. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The linked notification rules. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Management groups global notification endpoints. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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
.
The metadata. Support json-file and yaml-file.
The name of the resource provider hosted within ProviderHub.
Do not wait for the long-running operation to finish.
Notification options.
Notification settings. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The notifications object. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The opt-in headers.
The opt-out headers.
Optional features. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The subscription state override actions. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The profit center code for the subscription.
The profit center program id for the subscription.
The private resource provider configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The resource provider authorizations. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --provider-auth
--provider-authz
--provider-authorizations
.
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.
The ProviderHub metadata. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The provider type.
The provider version.
The accepted values are "Any" or "All".
The required features. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Resource hydration accounts Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The resource access policy.
The resource access roles. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Resource group lock option during move. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The resource provider authorization rules. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Response options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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
.
The service name.
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
.
The services. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The soft delete time to live.
The template deployment options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The token auth configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az providerhub provider-registration delete
Delete a provider registration.
az providerhub provider-registration delete [--ids]
[--name]
[--subscription]
[--yes]
Examples
provider-registration delete
az providerhub provider-registration delete -y --provider-namespace "{providerNamespace}"
Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The name of the resource provider hosted within ProviderHub.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Do not prompt for confirmation.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az providerhub 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
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The name of the resource provider hosted within ProviderHub.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
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
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.
Token to specify where to start paginating. This is the token value from a previously truncated response.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az providerhub provider-registration show
Get the provider registration details.
az providerhub provider-registration show [--ids]
[--name]
[--subscription]
Examples
provider-registration show
az providerhub provider-registration show --provider-namespace "{providerNamespace}"
Optional Parameters
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The name of the resource provider hosted within ProviderHub.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az providerhub provider-registration update
Update the provider registration.
az providerhub provider-registration update [--add]
[--authorization-owners]
[--canary-manifest-owners]
[--capabilities]
[--cross-tenant-token-validation {EnsureSecureValidation, PassthroughInsecureToken}]
[--custom-manifest-vers]
[--dsts-configuration]
[--enable-linked-notif {0, 1, f, false, n, no, t, true, y, yes}]
[--error-response-message-options]
[--expedited-rollout-metadata]
[--expedited-rollout-submitters]
[--force-string {0, 1, f, false, n, no, t, true, y, yes}]
[--global-notif-endpoints]
[--ids]
[--incident-contact-email]
[--incident-routing-service]
[--incident-routing-team]
[--kind {Direct, Hybrid, Managed}]
[--legacy-namespace]
[--legacy-registrations]
[--linked-notif-rules]
[--management-group-global-notification-endpoints]
[--manifest-owner]
[--metadata]
[--name]
[--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]
[--pc-code]
[--pc-program-id]
[--private-resource-provider-configuration]
[--provider-auth]
[--provider-authentication]
[--provider-hub-metadata]
[--provider-type {AuthorizationFree, External, Hidden, Internal, LegacyRegistrationRequired, NotSpecified, RegistrationFree, TenantOnly}]
[--provider-version]
[--remove]
[--req-features-policy {All, Any}]
[--required-features]
[--resc-hydration-accts]
[--resource-access-policy {AcisActionAllowed, AcisReadAllowed, NotSpecified}]
[--resource-access-roles]
[--resource-group-lock-option-during-move]
[--resource-provider-authorization-rules]
[--response-options]
[--schema-owner]
[--service-name]
[--service-tree-info]
[--services]
[--set]
[--soft-delete-ttl]
[--subscription]
[--template-deployment-options]
[--token-auth-config]
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
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>
.
The authorization owners. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
List of manifest owners for canary. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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
.
The cross tenant token validation.
Custom manifest version.
The DSTS configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The enable tenant linked notification.
Options for error response messages. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Metadata for expedited rollout. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
List of expedited rollout submitters. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
When using 'set' or 'add', preserve string literals instead of attempting to convert to JSON.
The global notification endpoints. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
One or more resource IDs (space-delimited). It should be a complete resource ID containing all information of 'Resource Id' arguments. You should provide either --ids or other 'Resource Id' arguments.
The email address of contacts for incidents related to the RP.
The service in IcM when creating or transferring incidents to the RP.
The team in IcM when creating or transferring incidents to the RP.
Provider registration kind. This Metadata is also used by portal/tooling/etc to render different UX experiences for resources of the same type.
Legacy namespace.
Legacy registrations. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The linked notification rules. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Management groups global notification endpoints. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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
.
The metadata. Support json-file and yaml-file.
The name of the resource provider hosted within ProviderHub.
The name of the resource provider hosted within ProviderHub.
Do not wait for the long-running operation to finish.
Notification options.
Notification settings. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The notifications object. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The opt-in headers.
The opt-out headers.
Optional features. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The subscription state override actions. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The profit center code for the subscription.
The profit center program id for the subscription.
The private resource provider configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The resource provider authorizations. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more. Singular flags: --provider-auth
--provider-authz
--provider-authorizations
.
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.
The ProviderHub metadata. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The provider type.
The provider version.
Remove a property or an element from a list. Example: --remove property.list <indexToRemove>
OR --remove propertyToRemove
.
The accepted values are "Any" or "All".
The required features. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Resource hydration accounts Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The resource access policy.
The resource access roles. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Resource group lock option during move. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The resource provider authorization rules. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Response options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
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
.
The service name.
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
.
The services. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Update an object by specifying a property path and value to set. Example: --set property1.property2=<value>
.
The soft delete time to live.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
The template deployment options. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
The token auth configuration. Support shorthand-syntax, json-file and yaml-file. Try "??" to show more.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
az providerhub 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]
[--subscription]
[--timeout]
[--updated]
Optional Parameters
Wait until created with 'provisioningState' at 'Succeeded'.
Wait until the condition satisfies a custom JMESPath query. E.g. provisioningState!='InProgress', instanceView.statuses[?code=='PowerState/running'].
Wait until deleted.
Wait until the resource exists.
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.
Polling interval in seconds.
The name of the resource provider hosted within ProviderHub.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Maximum wait in seconds.
Wait until updated with provisioningState at 'Succeeded'.
Global Parameters
Increase logging verbosity to show all debug logs.
Show this help message and exit.
Only show errors, suppressing warnings.
Output format.
JMESPath query string. See http://jmespath.org/ for more information and examples.
Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID
.
Increase logging verbosity. Use --debug for full debug logs.
Azure CLI