Skip to content

Commit

Permalink
update AzureBridge docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@rakku-ms @TheOnlyWei
rakku-ms authored and TheOnlyWei committed Mar 30, 2021
1 parent b7917f4 commit 7343914
Show file tree
Hide file tree
Showing 5 changed files with 183 additions and 8 deletions.
28 changes: 26 additions & 2 deletions src/Azs.AzureBridge.Admin/examples/Get-AzsAzureBridgeActivation.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,38 @@

### -------------------------- EXAMPLE 1 --------------------------
```powershell
Get-AzsAzureBridgeActivation -ResourceGroupName 'activationRG'
Get-AzsAzureBridgeActivation -ResourceGroupName "azurestack-activation"
AzureRegistrationResourceIdentifier : /subscriptions/5c17413c-1135-479b-a046-847e1ef9fbeb/resourceGroups/AzureStack-s31r21/providers/Microsoft.AzureStack/registrations/AzureStackCIRegistration-s31r2104
DisplayName : Azure Stack Activation
Expiration : 2022-03-22T02:56:11.024982Z
Id : /subscriptions/4d6112db-c97e-47d6-abd9-97ce61f62f2e/resourceGroups/azurestack-activation/providers/Microsoft.AzureBridge.Admin/activations/default
Location : redmond
MarketplaceSyndicationEnabled : True
Name : default
ProvisioningState : Succeeded
Tag : Microsoft.Azure.PowerShell.Cmdlets.BridgeAdmin.Models.Api201601.ResourceTags
Type : Microsoft.AzureBridge.Admin/activations
UsageReportingEnabled : True
```

Get a list of Azure Bridge Activations under the resource group "activationRG"

### -------------------------- EXAMPLE 2 --------------------------
```powershell
Get-AzsAzureBridgeActivation -Name 'myActivation' -ResourceGroupName 'activationRG'
Get-AzsAzureBridgeActivation -ResourceGroupName "azurestack-activation" -Name "default"
AzureRegistrationResourceIdentifier : /subscriptions/5c17413c-1135-479b-a046-847e1ef9fbeb/resourceGroups/AzureStack-s31r21/providers/Microsoft.AzureStack/registrations/AzureStackCIRegistration-s31r2104
DisplayName : Azure Stack Activation
Expiration : 2022-03-22T02:56:11.024982Z
Id : /subscriptions/4d6112db-c97e-47d6-abd9-97ce61f62f2e/resourceGroups/azurestack-activation/providers/Microsoft.AzureBridge.Admin/activations/default
Location : redmond
MarketplaceSyndicationEnabled : True
Name : default
ProvisioningState : Succeeded
Tag : Microsoft.Azure.PowerShell.Cmdlets.BridgeAdmin.Models.Api201601.ResourceTags
Type : Microsoft.AzureBridge.Admin/activations
UsageReportingEnabled : True
```

Get an Azure Bridge Activation by name 'myActivation' situated under 'activationRG'
112 changes: 110 additions & 2 deletions src/Azs.AzureBridge.Admin/examples/Get-AzsAzureBridgeDownloadedProduct.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,122 @@

### -------------------------- EXAMPLE 1 --------------------------
```powershell
Get-AzsAzureBridgeDownloadedProduct -ActivationName 'myActivation' -ResourceGroupName 'activationRG'
Get-AzsAzureBridgeDownloadedProduct -ActivationName "default" -ResourceGroupName "azurestack-activation" | Select -First 1
BillingPartNumber :
CompatibilityDescription :
CompatibilityIsCompatible :
CompatibilityIssue :
CompatibilityMessage :
Description : <p>Ghost is a publishing platform suitable for everything from personal blogs to major news websites.
</p><p></p><p>For developers, its modern technology stack is flexible enough to integrate with other applications
and tools. For content authors, content creation and management is extremely easy thanks to its simplified Ghost
editor dashboard that lets authors use easy-to-learn markdown while simultaneously seeing the real-time output in a
preview pane. </p><p></p><p>This image includes SSL auto-configuration with Let's Encrypt
certificates.</p><p></p><p>This open source solution is packaged by Bitnami. Learn how to install, configure, and
manage it at docs.bitnami.com. For deployment issues, reach out our support team at
community.bitnami.com.</p><p></p><p>Why use Bitnami Certified Apps? </p><p></p><p>Bitnami certified images are
always up-to-date, secure, and built to work right out of the box. </p><p></p><p>Bitnami packages applications
following industry standards, and continuously monitors all components and libraries for vulnerabilities and
application updates. When any security threat or update is identified, Bitnami automatically repackages the
applications and pushes the latest versions to the cloud marketplaces.</p><br>Ghost 3.37.1-0 (Debian 10)
DisplayName : Ghost Certified by Bitnami
GalleryItemIdentity : bitnami.ghostdefault.1.0.158
GalleryPackageBlobSasUri :
IconUriHero :
IconUriLarge : https://azstmktprodwcu001.blob.core.windows.net/icons/18d250d22e84486b8d68e196c0638e92/Large.png
IconUriMedium : https://azstmktprodwcu001.blob.core.windows.net/icons/18d250d22e84486b8d68e196c0638e92/Medium.png
IconUriSmall : https://azstmktprodwcu001.blob.core.windows.net/icons/18d250d22e84486b8d68e196c0638e92/Small.png
IconUriWide : https://azstmktprodwcu001.blob.core.windows.net/icons/18d250d22e84486b8d68e196c0638e92/Wide.png
Id : /subscriptions/4d6112db-c97e-47d6-abd9-97ce61f62f2e/resourceGroups/azurestack-activation/providers/Microsoft.AzureBri
dge.Admin/activations/default/downloadedProducts/bitnami.ghostdefault-3.37.2011041158
LegalTerm : Bitnami Terms of Use can be found at <a
href="https://www.vmware.com/help/legal.html">https://www.vmware.com/help/legal.html</a>
Link : {Learn More, Documentation, License Agreement, Bitnami Support}
Location :
Name : default/bitnami.ghostdefault-3.37.2011041158
Offer : ghost
OfferVersion : 1038
PayloadLength : 32212300322
PrivacyPolicy : https://www.vmware.com/help/privacy.html
ProductDetailPropertyComputeRole :
ProductDetailPropertyDataDiskImage :
ProductDetailPropertyIsSystemExtension :
ProductDetailPropertyOSDiskImageOperatingSystem :
ProductDetailPropertyOSDiskImageSourceBlobSasUri :
ProductDetailPropertySourceBlobUri :
ProductDetailPropertySupportMultipleExtension :
ProductDetailPropertyVMScaleSetEnabled :
ProductDetailPropertyVersion :
ProductDetailPropertyVmosType :
ProductKind : virtualMachine
ProductProperties : 3.37.2011041158
ProvisioningState : Succeeded
PublisherDisplayName : Bitnami
PublisherIdentifier : Bitnami
Sku : default
Tag : Microsoft.Azure.PowerShell.Cmdlets.BridgeAdmin.Models.Api201601.ResourceTags
Type : Microsoft.AzureBridge.Admin/activations/downloadedProducts
VMExtensionType :
```

Get a list of Azure Bridge Downloaded products

### -------------------------- EXAMPLE 2 --------------------------
```powershell
Get-AzsAzureBridgeDownloadedProduct -Name 'microsoft.docker-arm.1.1.0' -ActivationName 'myActivation' -ResourceGroupName 'activationRG'
Get-AzsAzureBridgeDownloadedProduct -Name 'microsoft.windowsserver2016-datacenter-payg-14393.3986.2010070045' -ActivationName 'default' -ResourceGroupName 'azurestack-activation'
BillingPartNumber :
CompatibilityDescription :
CompatibilityIsCompatible :
CompatibilityIssue :
CompatibilityMessage :
Description : Windows Server 2016 is a comprehensive server operating system designed to run the applications and infrastructure
that power your business. It includes built-in layers of security and innovation to help you run traditional and
cloud-native applications with confidence.<p><h3 class='msportalfx-text-header'>Legal Terms</h3></p><p>By clicking
the Create button, I acknowledge that I am getting this software from Microsoft and that the <a
href='https://go.microsoft.com/fwlink/?linkid=2014360' target='_blank'>legal terms</a> of Microsoft apply to it.
Microsoft does not provide rights for third-party software. Also see the <a
href='https://go.microsoft.com/fwlink/?LinkId=521839' target='_blank'>privacy statement</a> from Microsoft.</p>
DisplayName : Windows Server 2016 Datacenter-Pay as you go
GalleryItemIdentity : Microsoft.WindowsServer2016Datacenter-ARM.14393.3986.2010070045
GalleryPackageBlobSasUri :
IconUriHero :
IconUriLarge : https://azstmktprodwcu001.blob.core.windows.net/icons/e3a0aa9e4c4f49e1ad94f10524499a39/Large.png
IconUriMedium : https://azstmktprodwcu001.blob.core.windows.net/icons/e3a0aa9e4c4f49e1ad94f10524499a39/Medium.png
IconUriSmall : https://azstmktprodwcu001.blob.core.windows.net/icons/e3a0aa9e4c4f49e1ad94f10524499a39/Small.png
IconUriWide : https://azstmktprodwcu001.blob.core.windows.net/icons/e3a0aa9e4c4f49e1ad94f10524499a39/Wide.png
Id : /subscriptions/4d6112db-c97e-47d6-abd9-97ce61f62f2e/resourceGroups/azurestack-activation/providers/Microsoft.AzureBri
dge.Admin/activations/default/downloadedProducts/microsoft.windowsserver2016-datacenter-payg-14393.3986.2010070045
LegalTerm : https://go.microsoft.com/fwlink/?linkid=2014360
Link :
Location :
Name : default/microsoft.windowsserver2016-datacenter-payg-14393.3986.2010070045
Offer : windowsserver
OfferVersion : 14393.3986.2010070045
PayloadLength : 136367658454
PrivacyPolicy : https://go.microsoft.com/fwlink/?LinkId=521839
ProductDetailPropertyComputeRole :
ProductDetailPropertyDataDiskImage :
ProductDetailPropertyIsSystemExtension :
ProductDetailPropertyOSDiskImageOperatingSystem :
ProductDetailPropertyOSDiskImageSourceBlobSasUri :
ProductDetailPropertySourceBlobUri :
ProductDetailPropertySupportMultipleExtension :
ProductDetailPropertyVMScaleSetEnabled :
ProductDetailPropertyVersion :
ProductDetailPropertyVmosType :
ProductKind : virtualMachine
ProductProperties : 14393.3986.2010070045
ProvisioningState : Succeeded
PublisherDisplayName : Microsoft
PublisherIdentifier : MicrosoftWindowsServer
Sku : 2016-Datacenter
Tag : Microsoft.Azure.PowerShell.Cmdlets.BridgeAdmin.Models.Api201601.ResourceTags
Type : Microsoft.AzureBridge.Admin/activations/downloadedProducts
VMExtensionType :
```

Get an Azure Bridge Downloaded Product by Name
47 changes: 45 additions & 2 deletions src/Azs.AzureBridge.Admin/examples/Get-AzsAzureBridgeProduct.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,57 @@

### -------------------------- EXAMPLE 1 --------------------------
```powershell
Get-AzsAzureBridgeProduct -ActivationName 'myActivation' -ResourceGroupName 'activationRG'
Get-AzsAzureBridgeProduct -ActivationName 'default' -ResourceGroupName 'azurestack-activation' | Select -First 5 | ft *
BillingPartNumber CompatibilityDescription CompatibilityIsCompatible CompatibilityIssue CompatibilityMessage Description DisplayName
----------------- ------------------------ ------------------------- ------------------ -------------------- ----------- -----------
None True {} None Acronis Backup for Linux (preview)
None True {} None CoreOS Linux (Stable)
None True {} None Custom Script Extension
None True {} None BGInfo
None True {} None Free License: SQL Server 2016 SP2 Express on...
```

Get a list of Products available for download from Azure Marketplace.

### -------------------------- EXAMPLE 2 --------------------------
```powershell
Get-AzsAzureBridgeProduct -ActivationName 'myActivation' -ResourceGroupName 'activationRG' -Name 'microsoft.docker-arm.1.1.0'
Get-AzsAzureBridgeProduct -ActivationName 'default' -ResourceGroupName 'azurestack-activation' -Name 'microsoft.sqliaasextension-1.3.20590'
BillingPartNumber :
CompatibilityDescription : None
CompatibilityIsCompatible : True
CompatibilityIssue : {}
CompatibilityMessage : None
Description : This extension is required for deploying SQL Server Windows-based VMs on Azure Stack
DisplayName : SqlIaaSExtension
GalleryItemIdentity : Microsoft.SqlIaaSExtension.1.3.20590
IconUriHero :
IconUriLarge : https://azstmktprodwcu001.blob.core.windows.net/icons/dbf187f0c64c467f931482ee778e5a04/Large.png
IconUriMedium : https://azstmktprodwcu001.blob.core.windows.net/icons/dbf187f0c64c467f931482ee778e5a04/Medium.png
IconUriSmall : https://azstmktprodwcu001.blob.core.windows.net/icons/dbf187f0c64c467f931482ee778e5a04/Small.png
IconUriWide : https://azstmktprodwcu001.blob.core.windows.net/icons/dbf187f0c64c467f931482ee778e5a04/Wide.png
Id : /subscriptions/4d6112db-c97e-47d6-abd9-97ce61f62f2e/resourceGroups/azurestack-activation/providers/Microsoft.AzureBridge.Admin/activations/d
efault/products/microsoft.sqliaasextension-1.3.20590
LegalTerm :
Link : {}
Location :
Name : default/microsoft.sqliaasextension-1.3.20590
Offer :
OfferVersion :
PayloadLength : 7419601
PrivacyPolicy :
ProductKind : virtualMachineExtension
ProductProperties : 1.3.20590
ProvisioningState : Succeeded
PublisherDisplayName : Microsoft
PublisherIdentifier : Microsoft.SqlServer.Management
Sku :
Tag : Microsoft.Azure.PowerShell.Cmdlets.BridgeAdmin.Models.Api201601.ResourceTags
Type : Microsoft.AzureBridge.Admin/activations/products
VMExtensionType :
```

Get a product info available for download from Azure Marketplace by Name.
2 changes: 1 addition & 1 deletion src/Azs.AzureBridge.Admin/examples/Invoke-AzsAzureBridgeProductDownload.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### -------------------------- EXAMPLE 1 --------------------------
```powershell
Invoke-AzsAzureBridgeProductDownload -ActivationName 'myActivation' -Name 'microsoft.docker-arm.1.1.0' -ResourceGroupName 'activationRG'
Invoke-AzsAzureBridgeProductDownload -ActivationName 'default' -ResourceGroupName 'azurestack-activation' -Name 'microsoft.sqliaasextension-1.3.20590'
```

Download a product from Azure Marketplace
2 changes: 1 addition & 1 deletion src/Azs.AzureBridge.Admin/examples/Remove-AzsAzureBridgeDownloadedProduct.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

### -------------------------- EXAMPLE 1 --------------------------
```powershell
Remove-AzsAzureBridgeDownloadedProduct -ActivationName 'myActivation' -ProductName 'microsoft.docker-arm.1.1.0' -ResourceGroupName 'activationRG'
Remove-AzsAzureBridgeDownloadedProduct -ActivationName 'default' -ResourceGroupName 'azurestack-activation' -ProductName 'microsoft.sqliaasextension-1.3.20590'
```

Delete a product downloaded from Azure Marketplace

0 comments on commit 7343914

Please sign in to comment.