az providerhub provider-registration
Note
This reference is part of the providerhub extension for the Azure CLI (version 2.15.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 |
Deletes 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 |
Gets the list of the provider registrations in the subscription. |
Extension | GA |
| az providerhub provider-registration show |
Gets the provider registration details. |
Extension | GA |
az providerhub provider-registration create
Create the provider registration.
az providerhub provider-registration create --provider-namespace
[--capabilities]
[--incident-contact-email]
[--incident-routing-service]
[--incident-routing-team]
[--lighthouse-auth]
[--managed-by-tenant-id]
[--manifest-owners]
[--metadata]
[--metadata-authn]
[--metadata-authz]
[--namespace]
[--no-wait]
[--opt-in-headers {ClientGroupMembership, NotSpecified, SignedAuxiliaryTokens, SignedUserToken, UnboundedClientGroupMembership}]
[--override-actions]
[--provider-authentication]
[--provider-authorizations]
[--provider-type]
[--provider-version]
[--req-features-policy {All, Any}]
[--required-features]
[--resource-access-policy {AcisActionAllowed, AcisReadAllowed, NotSpecified}]
[--resource-access-roles]
[--schema-owners]
[--service-tree-infos]
[--soft-delete-ttl]
[--template-deployment-options]Examples
ProviderRegistrations_CreateOrUpdate
az providerhub provider-registration create --providerhub-metadata-authorizations application-id="00000000-0000-0000-0000-000000000000" role-definition-id="00000000-0000-0000-0000-000000000000" --providerhub-metadata-authentication allowed-audiences="https://management.core.windows.net/" --service-tree-infos service-id="00000000-0000-0000-0000-000000000000" component-id="00000000-0000-0000-0000-000000000000" --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 "helpme@contoso.com" --incident-routing-service "Contoso Resource Provider" --incident-routing-team "Contoso Triage" --provider-type "Internal" --provider-version "2.0" --provider-namespace "Microsoft.Contoso"Required Parameters
The name of the resource provider hosted within ProviderHub.
Optional Parameters
The resource provider capabilities.
Usage: --capabilities quota-id=XX effect=XX required-features=XX
Multiple actions can be specified by using more than one --capabilities argument.
The email address of contacts for incidents related to the RP.
Usage: --incident-contact-email "helpme@contoso.com".
The service in IcM when creating or transferring incidents to the RP.
Usage: --incident-routing-service "Contoso Resource Provider".
The team in IcM when creating or transferring incidents to the RP.
Usage: --incident-routing-team "Contoso Triage".
The lighthouse authorizations.
Usage: --lighthouse-authorizations principal-id=XX role-definition-id=XX
principal-id: Required. The principal ID. role-definition-id: Required. The role definition ID.
The managed by tenant ID.
Usage: --managed-by-tenant-id "00000000-0000-0000-0000-000000000000".
Specifies an array of required ACIS claims to modify the resource provider's manifest content via ACIS.
Usage: --manifest-owners "SPARTA-PlatformServiceAdministrator"
Multiple actions can be specified by using more than one --manifest-owners argument.
The metadata.
The ProviderHub metadata authentication.
Usage: --providerhub-metadata-authentication allowed-audiences=XX
allowed-audiences: Required. The allowed audiences.
The ProviderHub metadata authorizations.
Usage: --providerhub-metadata-authorizations application-id=XX role-definition-id=XX managed-by-role-definition-id=XX
application-id: Required. The application ID. role-definition-id: Required. The role definition ID. managed-by-role-definition-id: Required. The managed by role definition ID.
Multiple actions can be specified by using more than one --providerhub-metadata-authorizations argument.
The name of the resource provider hosted within ProviderHub.
Usage: --namespace "Microsoft.Contoso".
Do not wait for the long-running operation to finish.
The opt-in headers.
Usage: --opt-in-headers "SignedUserToken".
The subscription state override actions.
Usage: --subscription-state-override-actions state=XX action=XX
Multiple actions can be specified by using more than one --subscription-state-override-actions argument.
Used to set alternative audiences or resources that ARM should accept from the token while authenticating requests for the provider.
Usage: --provider-authentication allowed-audiences=XX
allowed-audiences: Required. The allowed audiences.
The resource provider authorizations.
Usage: --provider-authorizations application-id=XX role-definition-id=XX managed-by-role-definition-id=XX
application-id: Required. The application ID. role-definition-id: Required. The role definition ID. managed-by-role-definition-id: Required. The managed by role definition ID.
Multiple actions can be specified by using more than one --provider-authorizations argument.
The provider type.
Usage: --provider-type "Internal"
Available provider types include: Internal, External, Hidden, RegistrationFree, LegacyRegistrationRequired, TenantOnly, AuthorizationFree.
The provider version.
Usage: --provider-version "2.0".
The accepted values are "Any" or "All". If the value is "All", then only the subscriptions registered to all the corresponding feature flag will be allowed..
The required features.
The resource access policy.
Usage: --resource-access-policy "AcisReadAllowed, AcisActionAllowed".
The resource access roles. Expected value: json-string/@json-file.
Specifies an array of needed ACIS claims to modify the resource provider schema via ACIS.
Usage: --schema-owners "Contoso schema owners"
Multiple actions can be specified by using more than one --schema-owners argument.
The ServiceTree information for the resource provider.
Usage: --service-tree-infos service-id=XX component-id=XX
service-id: Required. The service ID. component-id: Required. The component ID.
Multiple actions can be specified by using more than one --service-tree-infos argument.
The soft delete time to live.
The template deployment options.
Usage: --template-deployment-options preflight-supported=XX preflight-options=XX.
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
Deletes a provider registration.
az providerhub provider-registration delete [--ids]
[--provider-namespace]
[--subscription]
[--yes]Examples
ProviderRegistrations_Delete
az providerhub provider-registration delete --provider-namespace "Microsoft.Contoso"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
ProviderRegistrations_GenerateOperations
az providerhub provider-registration generate-operation --provider-namespace "Microsoft.Contoso"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
Gets the list of the provider registrations in the subscription.
az providerhub provider-registration listExamples
ProviderRegistrations_List
az providerhub provider-registration listGlobal 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
Gets the provider registration details.
az providerhub provider-registration show [--ids]
[--provider-namespace]
[--subscription]Examples
ProviderRegistrations_Get
az providerhub provider-registration show --provider-namespace "Microsoft.Contoso"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.
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for