diff --git a/documentation/azure-powershell-modules.md b/documentation/azure-powershell-modules.md index 032c7c83d6f3..10acb9c03d20 100644 --- a/documentation/azure-powershell-modules.md +++ b/documentation/azure-powershell-modules.md @@ -99,6 +99,7 @@ Portal | `Az.Portal` Database for PostgreSQL | `Az.PostgreSql` | [![PostgreSql]][PostgreSqlGallery] Power BI Embedded | `Az.PowerBIEmbedded` | [![PowerBIEmbedded]][PowerBIEmbeddedGallery] Private Dns | `Az.PrivateDns` | [![PrivateDns]][PrivateDnsGallery] +Provider Hub | `Az.ProviderHub` | [![ProviderHub]][ProviderHubGallery] Recovery Services | `Az.RecoveryServices` | [![RecoveryServices]][RecoveryServicesGallery] Redis Cache | `Az.RedisCache` | [![RedisCache]][RedisCacheGallery] Redis Enterprise Cache | `Az.RedisEnterpriseCache` | [![RedisEnterpriseCache]][RedisEnterpriseCacheGallery] @@ -223,6 +224,7 @@ Windows Iot Services | `Az.WindowsIotServices` [PostgreSql]: https://img.shields.io/powershellgallery/v/Az.PostgreSql.svg?style=flat-square&label=Az.PostgreSql [PowerBIEmbedded]: https://img.shields.io/powershellgallery/v/Az.PowerBIEmbedded.svg?style=flat-square&label=Az.PowerBIEmbedded [PrivateDns]: https://img.shields.io/powershellgallery/v/Az.PrivateDns.svg?style=flat-square&label=Az.PrivateDns +[ProviderHub]: https://img.shields.io/powershellgallery/v/Az.ProviderHub.svg?style=flat-square&label=Az.ProviderHub [RecoveryServices]: https://img.shields.io/powershellgallery/v/Az.RecoveryServices.svg?style=flat-square&label=Az.RecoveryServices [RedisCache]: https://img.shields.io/powershellgallery/v/Az.RedisCache.svg?style=flat-square&label=Az.RedisCache [RedisEnterpriseCache]: https://img.shields.io/powershellgallery/v/Az.RedisEnterpriseCache.svg?style=flat-square&label=Az.RedisEnterpriseCache @@ -345,6 +347,7 @@ Windows Iot Services | `Az.WindowsIotServices` [PostgreSqlGallery]: https://www.powershellgallery.com/packages/Az.PostgreSql/ [PowerBIEmbeddedGallery]: https://www.powershellgallery.com/packages/Az.PowerBIEmbedded/ [PrivateDnsGallery]: https://www.powershellgallery.com/packages/Az.PrivateDns/ +[ProviderHubGallery]: https://www.powershellgallery.com/packages/Az.ProviderHub/ [RecoveryServicesGallery]: https://www.powershellgallery.com/packages/Az.RecoveryServices/ [RedisCacheGallery]: https://www.powershellgallery.com/packages/Az.RedisCache/ [RedisEnterpriseCacheGallery]: https://www.powershellgallery.com/packages/Az.RedisEnterpriseCache/ diff --git a/src/ProviderHub/help/Get-AzProviderHubCustomRollout.md b/src/ProviderHub/help/Get-AzProviderHubCustomRollout.md index ef824855a96c..91e9309dddd1 100644 --- a/src/ProviderHub/help/Get-AzProviderHubCustomRollout.md +++ b/src/ProviderHub/help/Get-AzProviderHubCustomRollout.md @@ -38,11 +38,11 @@ Gets the custom rollout details. ### Example 1: Get a custom rollout by rollout name. ```powershell PS C:\> Get-AzProviderHubCustomRollout -ProviderNamespace "Microsft.Contoso" -RolloutName "customRollout1" -``` Name Type ---- ---- customRollout1 Microsoft.ProviderHub/providerRegistrations/customRollouts +``` Get a custom rollout by rollout name. diff --git a/src/ProviderHub/help/Get-AzProviderHubDefaultRollout.md b/src/ProviderHub/help/Get-AzProviderHubDefaultRollout.md index 1757a8b1d296..844dbdecd1d3 100644 --- a/src/ProviderHub/help/Get-AzProviderHubDefaultRollout.md +++ b/src/ProviderHub/help/Get-AzProviderHubDefaultRollout.md @@ -38,23 +38,23 @@ Gets the default rollout details. ### Example 1: List all default rollouts under the resource provider. ```powershell PS C:\> Get-AzProviderHubDefaultRollout -ProviderNamespace "Microsoft.Contoso" -``` Name Type ---- ---- defaultRollout2021w10 Microsoft.ProviderHub/providerRegistrations/defaultRollouts defaultRollout2021w11 Microsoft.ProviderHub/providerRegistrations/defaultRollouts +``` List all default rollouts under the resource provider. ### Example 2: Get a specific rollout by name. ```powershell PS C:\> Get-AzProviderHubDefaultRollout -ProviderNamespace "Microsoft.Contoso" -RolloutName "defaultRollout2021w10" -``` Name Type ---- ---- defaultRollout2021w10 Microsoft.ProviderHub/providerRegistrations/defaultRollouts +``` Get a specific rollout by name. diff --git a/src/ProviderHub/help/Get-AzProviderHubNotificationRegistration.md b/src/ProviderHub/help/Get-AzProviderHubNotificationRegistration.md index fb53c92180f4..175b362ea0ff 100644 --- a/src/ProviderHub/help/Get-AzProviderHubNotificationRegistration.md +++ b/src/ProviderHub/help/Get-AzProviderHubNotificationRegistration.md @@ -38,23 +38,23 @@ Gets the notification registration details. ### Example 1: List all the notification registration by ProviderNamespace. ```powershell PS C:\> Get-AzProviderHubNotificationRegistration -ProviderNamespace "Microsoft.Contoso" -``` Name ---- notificationRegistrationTest1 notificationRegistrationTest2 +``` List all the notification registration in the provider namespace. ### Example 1: Get the notification registration by name. ```powershell PS C:\> Get-AzProviderHubNotificationRegistration -ProviderNamespace "Microsoft.Contoso" -Name "notificationRegistrationTest" -``` Name ---- notificationRegistrationTest +``` Get the notification registration by name. diff --git a/src/ProviderHub/help/Get-AzProviderHubProviderRegistration.md b/src/ProviderHub/help/Get-AzProviderHubProviderRegistration.md index 23cbdb031570..ca268523da55 100644 --- a/src/ProviderHub/help/Get-AzProviderHubProviderRegistration.md +++ b/src/ProviderHub/help/Get-AzProviderHubProviderRegistration.md @@ -38,11 +38,11 @@ Gets the provider registration details. ### Example 1: Get the provider registration. ```powershell PS C:\> Get-AzProviderHubProviderRegistration -ProviderNamespace "Microsoft.Contoso" -``` Name Type ---- ---- Microsoft.Contoso Microsoft.ProviderHub/providerRegistrations +``` Get the provider registration. diff --git a/src/ProviderHub/help/Get-AzProviderHubResourceTypeRegistration.md b/src/ProviderHub/help/Get-AzProviderHubResourceTypeRegistration.md index 449e1a554639..d1d428e0487c 100644 --- a/src/ProviderHub/help/Get-AzProviderHubResourceTypeRegistration.md +++ b/src/ProviderHub/help/Get-AzProviderHubResourceTypeRegistration.md @@ -38,23 +38,23 @@ Gets a resource type details in the given subscription and provider. ### Example 1: List all resource types under the resource provider namespace. ```powershell PS C:\> Get-AzProviderHubResourceTypeRegistration -ProviderNamespace "Microsoft.Contoso" -``` Name Type ---- ---- testResourceType1 Microsoft.ProviderHub/providerRegistrations/resourceTypeRegistrations testResourceType2 Microsoft.ProviderHub/providerRegistrations/resourceTypeRegistrations +``` List all resource types under the resource provider namespace. ### Example 2: Gets a resource type by name. ```powershell PS C:\> Get-AzProviderHubResourceTypeRegistration -ProviderNamespace "Microsoft.Contoso" -ResourceType "testResourceType1" -``` Name Type ---- ---- testResourceType1 Microsoft.ProviderHub/providerRegistrations/resourceTypeRegistrations +``` Gets a resource type by name. diff --git a/src/ProviderHub/help/Get-AzProviderHubSku.md b/src/ProviderHub/help/Get-AzProviderHubSku.md index e465f29ce0d7..0ba8f5addfbb 100644 --- a/src/ProviderHub/help/Get-AzProviderHubSku.md +++ b/src/ProviderHub/help/Get-AzProviderHubSku.md @@ -57,11 +57,11 @@ Gets the sku details for the given resource type and sku name. ### Example 1: Get the resource SKU definition. ```powershell PS C:\> Get-AzProviderHubSku -ProviderNamespace "Microsoft.Contoso" -ResourceType "testResourceType" -Sku "default" -``` Name Type ---- ---- testResourceType Microsoft.ProviderHub/providerRegistrations/skus +``` Get the resource SKU definition. diff --git a/src/ProviderHub/help/Invoke-AzProviderHubManifestCheckin.md b/src/ProviderHub/help/Invoke-AzProviderHubManifestCheckin.md index 9c9923f2200c..f830fd21aba3 100644 --- a/src/ProviderHub/help/Invoke-AzProviderHubManifestCheckin.md +++ b/src/ProviderHub/help/Invoke-AzProviderHubManifestCheckin.md @@ -26,22 +26,22 @@ Checkin the manifest. ### Example 1: Checkin the resource provider manifest. ```powershell PS C:\> Invoke-AzProviderHubManifestCheckin -ProviderNamespace "Microsoft.Contoso" -BaselineArmManifestLocation "NorthEurope" -Environment "Canary" -``` CommitId IsCheckedIn PullRequest StatusMessage -------- ----------- ----------- ------------- False Manifest is successfully merged. +``` Checkin the resource provider manifest. ### Example 2: Checkin the resource provider manifest. ```powershell PS C:\> Invoke-AzProviderHubManifestCheckin -ProviderNamespace "Microsoft.Contoso" -BaselineArmManifestLocation "EastUS2EUAP" -Environment "Prod" -``` CommitId IsCheckedIn PullRequest StatusMessage -------- ----------- ----------- ------------- False Manifest is successfully merged. +``` Checkin the resource provider manifest. diff --git a/src/ProviderHub/help/New-AzProviderHubCustomRollout.md b/src/ProviderHub/help/New-AzProviderHubCustomRollout.md index f4909f201fc9..0340f7568a39 100644 --- a/src/ProviderHub/help/New-AzProviderHubCustomRollout.md +++ b/src/ProviderHub/help/New-AzProviderHubCustomRollout.md @@ -29,11 +29,11 @@ Creates or updates the rollout details. ### Example 1: Create/Update a resource provider custom rollout. ```powershell PS C:\> New-AzProviderHubCustomRollout -ProviderNamespace "Microsoft.Contoso" -RolloutName "customRollout1" -CanaryRegion "Eastus2EUAP" -``` Name Type ---- ---- customRollout1 Microsoft.ProviderHub/providerRegistrations/customRollouts +``` Create/Update a resource provider custom rollout. diff --git a/src/ProviderHub/help/New-AzProviderHubDefaultRollout.md b/src/ProviderHub/help/New-AzProviderHubDefaultRollout.md index eec506820149..a3e31aded17a 100644 --- a/src/ProviderHub/help/New-AzProviderHubDefaultRollout.md +++ b/src/ProviderHub/help/New-AzProviderHubDefaultRollout.md @@ -35,11 +35,11 @@ Creates or updates the rollout details. ### Example 1: Create/Update a resource provider default rollout. ```powershell PS C:\> New-AzProviderHubDefaultRollout -ProviderNamespace "Microsoft.Contoso" -RolloutName "defaultRollout2021w10" -CanarySkipRegion "brazilus" -NoWait -``` Name Type ---- ---- defaultRollout2021w10 Microsoft.ProviderHub/providerRegistrations/defaultRollouts +``` Create/Update a resource provider default rollout. diff --git a/src/ProviderHub/help/New-AzProviderHubManifest.md b/src/ProviderHub/help/New-AzProviderHubManifest.md index 009e6bae09a2..93bfbbabc7b7 100644 --- a/src/ProviderHub/help/New-AzProviderHubManifest.md +++ b/src/ProviderHub/help/New-AzProviderHubManifest.md @@ -32,22 +32,22 @@ Generates the manifest for the given provider. ### Example 1: Generate the resource provider manifest. ```powershell PS C:\> New-AzProviderHubManifest -ProviderNamespace "Microsoft.Contoso" -``` Namespace ProviderType ProviderVersion RequiredFeature --------- ------------ --------------- --------------- Microsoft.Contoso Internal, Hidden 2.0 +``` Generate the resource provider manifest. ### Example 2: Generate the resource provider manifest. ```powershell PS C:\> New-AzProviderHubManifest -ProviderNamespace "Microsoft.Contoso" -``` Namespace ProviderType ProviderVersion RequiredFeature --------- ------------ --------------- --------------- Microsoft.Contoso Internal, Hidden 2.0 +``` Generate the resource provider manifest. diff --git a/src/ProviderHub/help/New-AzProviderHubNotificationRegistration.md b/src/ProviderHub/help/New-AzProviderHubNotificationRegistration.md index c7f2bb55e604..4833ebc0cb95 100644 --- a/src/ProviderHub/help/New-AzProviderHubNotificationRegistration.md +++ b/src/ProviderHub/help/New-AzProviderHubNotificationRegistration.md @@ -27,22 +27,22 @@ Creates or updates a notification registration. ### Example 1: Create/Update a notification registration. ```powershell PS C:\> New-AzProviderHubNotificationRegistration -ProviderNamespace "Microsoft.Contoso" -Name "notificationRegistrationTest" -NotificationMode "EventHub" -MessageScope "RegisteredSubscriptions" -IncludedEvent "*/write", "Microsoft.Contoso/testResourceType/delete" -NotificationEndpoint @{Location = "", "East US"; NotificationDestination = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mgmtexp-eastus/providers/Microsoft.EventHub/namespaces/unitedstates-mgmtexpint/eventhubs/armlinkednotifications"} -``` Name ---- notificationRegistrationTest +``` Create/Update a notification registration. ### Example 2: Create/Update a notification registration. ```powershell PS C:\> New-AzProviderHubNotificationRegistration -ProviderNamespace "Microsoft.Contoso" -Name "notificationRegistrationTest" -NotificationMode "EventHub" -MessageScope "RegisteredSubscriptions" -IncludedEvent "*/write", "Microsoft.Contoso/testResourceType/delete" -NotificationEndpoint @{Location = "", "East US"; NotificationDestination = "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/mgmtexp-eastus/providers/Microsoft.EventHub/namespaces/unitedstates-mgmtexpint/eventhubs/armlinkednotifications"} -``` Name ---- notificationRegistrationTest +``` Create/Update a notification registration. diff --git a/src/ProviderHub/help/New-AzProviderHubProviderRegistration.md b/src/ProviderHub/help/New-AzProviderHubProviderRegistration.md index c33084253c0d..46b340845708 100644 --- a/src/ProviderHub/help/New-AzProviderHubProviderRegistration.md +++ b/src/ProviderHub/help/New-AzProviderHubProviderRegistration.md @@ -41,22 +41,22 @@ Creates or updates the provider registration. ### Example 1: Create/Update a provider registration. ```powershell PS C:\> New-AzProviderHubProviderRegistration -ProviderNamespace "Microsoft.Contoso" -ProviderHubMetadataProviderAuthenticationAllowedAudience "https://management.core.windows.net/" -ProviderHubMetadataProviderAuthorization @{ApplicationId = "00000000-0000-0000-0000-000000000000"; RoleDefinitionId = "00000000-0000-0000-0000-000000000000"} -Namespace "Microsoft.Contoso" -ProviderVersion "2.0" -ProviderType "Internal" -ManagementManifestOwner "SPARTA-PlatformServiceAdministrator" -ManagementIncidentContactEmail "help@microsoft.com" -ManagementIncidentRoutingService "Contoso Service" -ManagementIncidentRoutingTeam "Contoso Team" -ManagementServiceTreeInfo @{ComponentId = "00000000-0000-0000-0000-000000000000"; ServiceId = "00000000-0000-0000-0000-000000000000"} -Capability @{QuotaId = "CSP_2015-05-01"; Effect = "Allow"}, @{QuotaId = "CSP_MG_2017-12-01"; Effect = "Allow"} -``` Name Type ---- ---- Microsoft.Contoso Microsoft.ProviderHub/providerRegistrations +``` Create/Update a provider registration. ### Example 2: Create/Update a provider registration. ```powershell PS C:\> New-AzProviderHubProviderRegistration -ProviderNamespace "Microsoft.Contoso" -ProviderHubMetadataProviderAuthenticationAllowedAudience "https://management.core.windows.net/" -ProviderHubMetadataProviderAuthorization @{ApplicationId = "00000000-0000-0000-0000-000000000000"; RoleDefinitionId = "00000000-0000-0000-0000-000000000000"} -Namespace "Microsoft.Contoso" -ProviderVersion "2.0" -ProviderType "Hidden" -ManagementManifestOwner "SPARTA-PlatformServiceAdministrator" -ManagementIncidentContactEmail "help@microsoft.com" -ManagementIncidentRoutingService "Contoso Service" -ManagementIncidentRoutingTeam "Contoso Team" -ManagementServiceTreeInfo @{ComponentId = "00000000-0000-0000-0000-000000000000"; ServiceId = "00000000-0000-0000-0000-000000000000"} -Capability @{QuotaId = "CSP_2015-05-01"; Effect = "Allow"}, @{QuotaId = "CSP_MG_2017-12-01"; Effect = "Allow"} -``` Name Type ---- ---- Microsoft.Contoso Microsoft.ProviderHub/providerRegistrations +``` Create/Update a provider registration. diff --git a/src/ProviderHub/help/New-AzProviderHubResourceTypeRegistration.md b/src/ProviderHub/help/New-AzProviderHubResourceTypeRegistration.md index 8435fac34877..09768872d82c 100644 --- a/src/ProviderHub/help/New-AzProviderHubResourceTypeRegistration.md +++ b/src/ProviderHub/help/New-AzProviderHubResourceTypeRegistration.md @@ -45,22 +45,22 @@ Creates or updates a resource type. ### Example 1: Create/Update a resource type registration. ```powershell PS C:\> New-AzProviderHubResourceTypeRegistration -ProviderNamespace "Microsoft.Contoso" -ResourceType "testResourceType" -RoutingType "Default" -Regionality "Regional" -Endpoint @{ApiVersion = "2021-01-01-preview"; Location = "West US 2", "East US 2 EUAP"; RequiredFeature = "Microsoft.Contoso/SampleApp" } -SwaggerSpecification @{ApiVersion = "2021-01-01-preview"; SwaggerSpecFolderUri = "https://github.com/Azure/azure-rest-api-specs-pr/blob/RPSaaSMaster/specification/rpsaas/resource-manager/Microsoft.Contoso/" } -EnableAsyncOperation -``` Name Type ---- ---- testResourceType Microsoft.ProviderHub/providerRegistrations/resourceTypeRegistrations +``` Create/Update a resource type registration. ### Example 2: Create/Update a resource type registration. ```powershell PS C:\> New-AzProviderHubResourceTypeRegistration -ProviderNamespace "Microsoft.Contoso" -ResourceType "testResourceType" -RoutingType "Default" -Regionality "Regional" -Endpoint @{ApiVersion = "2021-01-01-preview"; Location = "West US 2", "East US 2 EUAP"; RequiredFeature = "Microsoft.Contoso/SampleApp" } -SwaggerSpecification @{ApiVersion = "2021-01-01-preview"; SwaggerSpecFolderUri = "https://github.com/Azure/azure-rest-api-specs-pr/blob/RPSaaSMaster/specification/rpsaas/resource-manager/Microsoft.Contoso/" } -EnableAsyncOperation -``` Name Type ---- ---- testResourceType Microsoft.ProviderHub/providerRegistrations/resourceTypeRegistrations +``` Create/Update a resource type registration. diff --git a/src/ProviderHub/help/New-AzProviderHubSku.md b/src/ProviderHub/help/New-AzProviderHubSku.md index fa82908ae9b3..95dcde5dfc4d 100644 --- a/src/ProviderHub/help/New-AzProviderHubSku.md +++ b/src/ProviderHub/help/New-AzProviderHubSku.md @@ -26,22 +26,22 @@ Creates or updates the resource type skus in the given resource type. ### Example 1: Create/Update a resource SKU definition. ```powershell PS C:\> New-AzProviderHubSku -ProviderNamespace "Microsoft.Contoso" -ResourceType "Employees" -Sku "default" -SkuSetting @{Name = "freeSku"; Tier = "Tier1"; Kind = "Standard"} -``` Name Type ---- ---- default Microsoft.ProviderHub/providerRegistrations/skus +``` Create/Update a resource SKU definition. ### Example 2: Create/Update a resource SKU definition. ```powershell PS C:\> New-AzProviderHubSku -ProviderNamespace "Microsoft.Contoso" -ResourceType "Employees" -Sku "default" -SkuSetting @{Name = "freeSku"; Tier = "Tier1"; Kind = "Standard"} -``` Name Type ---- ---- default Microsoft.ProviderHub/providerRegistrations/skus +``` Create/Update a resource SKU definition.