Skip to content

Commit

Permalink
Moved Aladdin example note outside of code block (#18357)
Browse files Browse the repository at this point in the history
Co-authored-by: Mike F. Robbins <mikefrobbins@users.noreply.github.com>
  • Loading branch information
mikefrobbins and mikefrobbins committed Jun 1, 2022
1 parent 39d81ed commit 344958f
Show file tree
Hide file tree
Showing 131 changed files with 263 additions and 215 deletions.
3 changes: 2 additions & 1 deletion src/Accounts/Accounts/help/Disable-AzContextAutosave.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ Disable autosave for the current user.

Turn off autosaving Azure credentials in this powershell session. (autogenerated)

```powershell <!-- Aladdin Generated Example -->
<!-- Aladdin Generated Example -->
```powershell
Disable-AzContextAutosave -Scope Process
```

Expand Down
3 changes: 2 additions & 1 deletion src/Accounts/Accounts/help/Enable-AzContextAutosave.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@ Enable-AzContextAutosave
Allow the Azure credential, account, and subscription information, to be saved and automatically
loaded when you open a PowerShell window in this PowerShell session. (autogenerated)

```powershell <!-- Aladdin Generated Example -->
<!-- Aladdin Generated Example -->
```powershell
Enable-AzContextAutosave -Scope Process
```

Expand Down
5 changes: 3 additions & 2 deletions src/Accounts/Accounts/help/Select-AzContext.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Select-AzContext [-Scope <ContextModificationScope>] [-DefaultProfile <IAzureCon
```

## DESCRIPTION
Select a subscription to target (or account or tenant) in Azure PowerShell cmdlets. After this cmdlet, future cmdlets will target the
Select a subscription to target (or account or tenant) in Azure PowerShell cmdlets. After this cmdlet, future cmdlets will target the
selected context.

## EXAMPLES
Expand All @@ -47,7 +47,8 @@ Target future Azure PowerShell cmdlets at the account, tenant, and subscription

Select a subscription and account to target in Azure PowerShell cmdlets in this powershell session. (autogenerated)

```powershell <!-- Aladdin Generated Example -->
<!-- Aladdin Generated Example -->
```powershell
Select-AzContext -Name TestEnvironment -Scope Process
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,8 @@ This command creates an API `echoapiv3` in ApiVersionSet `xmsVersionSet` and cop

Creates an API. (autogenerated)

```powershell
<!-- Aladdin Generated Example -->
```powershell
New-AzApiManagementApi -ApiId '0001' -Context <PsApiManagementContext> -Name 'Echo api' -Path 'echov3' -Protocols Http -ServiceUrl 'https://contoso.com/apis/echo'
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ This command creates an authorization server.

Creates an authorization server. (autogenerated)

<!-- Aladdin Generated Example -->
```powershell
<!-- Aladdin Generated Example -->
New-AzApiManagementAuthorizationServer -AccessTokenSendingMethods AuthorizationHeader -AuthorizationEndpointUrl 'https://contoso/auth' -AuthorizationRequestMethods Get -ClientAuthenticationMethods Basic -ClientId 'clientid' -ClientRegistrationPageUrl 'https://contoso/signup' -ClientSecret '0000000000000000000000000000000000000' -Context <PsApiManagementContext> -GrantTypes AuthorizationCode -Name 'Contoso OAuth2 server' -ServerId '0123456789' -TokenBodyParameters @{'par1'='val1'} -TokenEndpointUrl 'https://contoso/token'
```

Expand Down Expand Up @@ -225,8 +225,8 @@ Accept wildcard characters: False
Specifies an array of grant types.
psdx_paramvalues
- AuthorizationCode
- ClientCredentials
- Implicit
- ClientCredentials
- Implicit
- ResourceOwnerPassword
```yaml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,15 +44,15 @@ This command uploads a certificate to Api Management. This certificate can be us

Creates an API Management certificate to be used during Authentication with Backend. (autogenerated)

<!-- Aladdin Generated Example -->
```powershell
<!-- Aladdin Generated Example -->
New-AzApiManagementCertificate -CertificateId '0123456789' -Context <PsApiManagementContext> -PfxFilePath 'C:\contoso\certificates\apimanagement.pfx' -PfxPassword '1111'
```

### Example 3 : Create a keyVault Certificate
```powershell
$secretIdentifier = 'https://contoso.vault.azure.net/secrets/xxxx'
$keyvault = New-AzApiManagementKeyVaultObject -SecretIdentifier $secretIdentifier
$keyvault = New-AzApiManagementKeyVaultObject -SecretIdentifier $secretIdentifier
$keyVaultcert = New-AzApiManagementCertificate -Context $context -CertificateId $kvcertId -KeyVault $keyvault
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ This command creates a management group.

Creates an API management group. (autogenerated)

<!-- Aladdin Generated Example -->
```powershell
<!-- Aladdin Generated Example -->
New-AzApiManagementGroup -Context <PsApiManagementContext> -Description 'Create Echo Api V4' -GroupId '0001' -Name 'Group0001' -Type Custom
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,15 +43,15 @@ This command creates a logger named ContosoSdkEventHub by using the specified co

Creates an API Management Logger. (autogenerated)

<!-- Aladdin Generated Example -->
```powershell
<!-- Aladdin Generated Example -->
New-AzApiManagementLogger -Context <PsApiManagementContext> -InstrumentationKey <String> -LoggerId 'Logger123'
```

## PARAMETERS

### -ConnectionString
Specifies an Azure Event Hubs connection string that starts with the following:
Specifies an Azure Event Hubs connection string that starts with the following:
`Endpoint=endpoint and key from Azure classic portal`
The Key with Send Rights in the connection string must be configured.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,8 @@ This command creates an OpenID Connect **Provider** named Contoso OpenID Connect

Creates an OpenID Connect provider. (autogenerated)

<!-- Aladdin Generated Example -->
```powershell
<!-- Aladdin Generated Example -->
New-AzApiManagementOpenIdConnectProvider -ClientId '12432143' -ClientSecret '000000000000000000000000000000000000000000' -Context <PsApiManagementContext> -Description 'OpenID Connect provider description' -MetadataEndpointUri 'https://openid.provider/configuration' -Name 'Contoso OpenID Connect Provider' -OpenIdConnectProviderId 'OICProvider01'
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ Creates a sampling setting of `Fixed` type with logging for 100% of the requests

Create a new sampling setting for the Diagnostic. (autogenerated)

<!-- Aladdin Generated Example -->
```powershell
<!-- Aladdin Generated Example -->
New-AzApiManagementSamplingSetting -SamplingPercentage 100 -SamplingType fixed
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ This script get the Git user configured in ApiManagement service and generates a

Generates a Shared Access Token for the User. (autogenerated)

<!-- Aladdin Generated Example -->
```powershell
<!-- Aladdin Generated Example -->
New-AzApiManagementUserToken -Context <PsApiManagementContext> -Expiry <DateTime> -UserId <String>
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,8 +41,8 @@ This command removes the `2` revision of the API `echo-api` from API Management

This command removes the 2 revision of the API echo-api from API Management service. (autogenerated)

<!-- Aladdin Generated Example -->
```powershell
<!-- Aladdin Generated Example -->
Remove-AzApiManagementApiRevision -ApiId '0001' -ApiRevision 6 -Context <PsApiManagementContext>
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ The script removes the Schema `2` from the Api `echo-api` if it is not reference

The script removes the Schema 2 from the Api echo-api if it is not referenced. (autogenerated)

<!-- Aladdin Generated Example -->
```powershell
<!-- Aladdin Generated Example -->
Remove-AzApiManagementApiSchema -ApiId '0001' -Context <PsApiManagementContext> -SchemaId 5cc9cf67e6ed3b1154e638bd
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ The example updates the Api Schema

Modifies an API Schema. (autogenerated)

<!-- Aladdin Generated Example -->
```powershell
<!-- Aladdin Generated Example -->
Set-AzApiManagementApiSchema -ApiId 'echo-api' -Context <PsApiManagementContext> -SchemaDocumentContentType swaggerdefinition -SchemaDocumentFilePath C:\Users\sasolank\Downloads\petstoreschema.json -SchemaId '2'
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,8 @@ This command modifies the specified API Management authorization server.

Modifies an authorization server. (autogenerated)

<!-- Aladdin Generated Example -->
```powershell
<!-- Aladdin Generated Example -->
Set-AzApiManagementAuthorizationServer -AccessTokenSendingMethods AuthorizationHeader -AuthorizationEndpointUrl 'https://contoso/authv2' -AuthorizationRequestMethods Get -ClientAuthenticationMethods Basic -ClientId 'clientid' -ClientRegistrationPageUrl 'https://contoso/signupv2' -ClientSecret '0000000000000000000000000000000000000' -Context <PsApiManagementContext> -DefaultScope <String> -GrantTypes AuthorizationCode -Name 'Contoso OAuth2 server' -ServerId 0123456789 -TokenEndpointUrl 'https://contoso/tokenv2'
```

Expand Down Expand Up @@ -225,8 +225,8 @@ Accept wildcard characters: False
Specifies an array of grant types.
psdx_paramvalues
- AuthorizationCode
- ClientCredentials
- Implicit
- ClientCredentials
- Implicit
- ResourceOwnerPassword
```yaml
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ Set-AzApiManagementBackend -Context $apimContext -BackendId 123 -Description "up

Updates a Backend. (autogenerated)

<!-- Aladdin Generated Example -->
```powershell
<!-- Aladdin Generated Example -->
Set-AzApiManagementBackend -BackendId 123 -Context <PsApiManagementContext> -Credential <PsApiManagementBackendCredential> -Protocol http -ResourceId /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso -Url 'https://contoso.com/awesomeapi'
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,8 @@ This command modifies the specified diagnostic Sampling Percentage from 100 to 5

Modifies an API Management diagnostic at the Global or Api scope. (autogenerated)

<!-- Aladdin Generated Example -->
```powershell
<!-- Aladdin Generated Example -->
Set-AzApiManagementDiagnostic -AlwaysLog allErrors -ApiId '0001' -Context <PsApiManagementContext> -DiagnosticId 'applicationinsights' -LoggerId 'Logger123' -SamplingSetting <PsApiManagementSamplingSetting>
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,8 +47,8 @@ The cmdlet updates the Client Secret of the Facebook Identity Provider;

Updates the Configuration of an existing Identity Provider. (autogenerated)

<!-- Aladdin Generated Example -->
```powershell
<!-- Aladdin Generated Example -->
Set-AzApiManagementIdentityProvider -AllowedTenants 'samirtestbc.onmicrosoft.com' -Authority <String> -ClientId 'clientid' -ClientSecret 'updatedSecret' -Context <PsApiManagementContext> -PasswordResetPolicyName <String> -ProfileEditingPolicyName <String> -SigninPolicyName <String> -SignupPolicyName B2C_1_signup-policy -Type Facebook
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@ This command modifies a logger that has the ID Logger123.

Modifies an API Management Logger. (autogenerated)

<!-- Aladdin Generated Example -->
```powershell
<!-- Aladdin Generated Example -->
Set-AzApiManagementLogger -Confirm -Context <PsApiManagementContext> -InstrumentationKey <String> -LoggerId 'Logger123'
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@ This command changes the named value to be Encrypted.

Modifies an API Management Named Value. (autogenerated)

<!-- Aladdin Generated Example -->
```powershell
<!-- Aladdin Generated Example -->
Set-AzApiManagementNamedValue -Context <PsApiManagementContext> -Name 'ContosoApi' -NamedValueId 'Property11' -Secret $true -Tag <String[]> -Value 'Property Value'
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ The command specifies a client secret for the provider.

Modifies an OpenID Connect provider. (autogenerated)

<!-- Aladdin Generated Example -->
```powershell
<!-- Aladdin Generated Example -->
Set-AzApiManagementOpenIdConnectProvider -ClientId 'clientid' -ClientSecret 'q2w3e43r45' -Context <PsApiManagementContext> -OpenIdConnectProviderId 'OICProvider01' -PassThru
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ This command sets the operation details for API management.

Sets API operation details. (autogenerated)

<!-- Aladdin Generated Example -->
```powershell
<!-- Aladdin Generated Example -->
Set-AzApiManagementOperation -ApiId '0001' -Context <PsApiManagementContext> -Method 'GET' -Name 'ContosoApi' -OperationId 'Operation003' -UrlTemplate '/newresource'
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,8 +38,8 @@ This command sets a new user password and email address and blocks the user.

Sets user details. (autogenerated)

<!-- Aladdin Generated Example -->
```powershell
<!-- Aladdin Generated Example -->
Set-AzApiManagementUser -Context <PsApiManagementContext> -Email 'patti.fuller@contoso.com' -FirstName 'Patti' -LastName 'Fuller' -Password <SecureString> -State Active -UserId '0123456789'
```

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@ This command gets the API Management Premium SKU service, having regions in Sout

Updates existing deployment region in PsApiManagement instance. (autogenerated)

<!-- Aladdin Generated Example -->
```powershell
<!-- Aladdin Generated Example -->
Update-AzApiManagementRegion -ApiManagement <PsApiManagement> -Capacity 2 -Location 'North Central US' -Sku Developer -VirtualNetwork <PsApiManagementVirtualNetwork>
```

Expand Down
3 changes: 2 additions & 1 deletion src/Compute/Compute/help/Disable-AzVmssDiskEncryption.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ Disables disk encryption on the VM scale set named VMSS001 that belongs to the r

Disables disk encryption on a VM scale set. (autogenerated)

```powershell <!-- Aladdin Generated Example -->
<!-- Aladdin Generated Example -->
```powershell
Disable-AzVmssDiskEncryption -ResourceGroupName 'Group001' -VMScaleSetName 'VMSS001' -VolumeType OS
```

Expand Down
3 changes: 2 additions & 1 deletion src/Compute/Compute/help/Get-AzVMADDomainExtension.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ The **Get-AzVMADDomainExtension** cmdlet gets information about the specified Az

Gets information about an AD domain extension. (autogenerated)

```powershell <!-- Aladdin Generated Example -->
<!-- Aladdin Generated Example -->
```powershell
Get-AzVMADDomainExtension -Name 'AgentPool01' -ResourceGroupName myresourcegroup -VMName 'VM01'
```

Expand Down
3 changes: 2 additions & 1 deletion src/Compute/Compute/help/Get-AzVMDiagnosticsExtension.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,8 @@ This command gets the diagnostics extension applied to the virtual machine named

Gets the settings of the Diagnostics extension on a virtual machine. (autogenerated)

```powershell <!-- Aladdin Generated Example -->
<!-- Aladdin Generated Example -->
```powershell
Get-AzVMDiagnosticsExtension -Name 'AgentPool01' -ResourceGroupName 'ResourceGroup11' -Status -VMName 'ContosoVM22'
```

Expand Down
2 changes: 1 addition & 1 deletion src/Compute/Compute/help/Get-AzVMDscExtensionStatus.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ When a configuration is applied this cmdlet produces output consistent with the

Gets the status of the DSC extension handler for a virtual machine. (autogenerated)

<!-- Aladdin Generated Example -->
```powershell
<!-- Aladdin Generated Example -->
Get-AzVMDscExtensionStatus -Name 'AgentPool01' -ResourceGroupName myresourcegroup -VMName 'VM01'
```

Expand Down
3 changes: 2 additions & 1 deletion src/Compute/Compute/help/New-AzProximityPlacementGroup.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ This command creates a proximity place group in the given location.

Create Proximity Placement Group resource. (autogenerated)

```powershell <!-- Aladdin Generated Example -->
<!-- Aladdin Generated Example -->
```powershell
New-AzProximityPlacementGroup -Location westus -Name 'AgentPool01' -ProximityPlacementGroupType <String> -ResourceGroupName myresourcegroup
```

Expand Down
2 changes: 1 addition & 1 deletion src/Compute/Compute/help/New-AzSnapshotConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,8 +50,8 @@ The last command takes the snapshot object and creates a snapshot with name 'Sna

Creates a configurable snapshot object. (autogenerated)

<!-- Aladdin Generated Example -->
```powershell
<!-- Aladdin Generated Example -->
New-AzSnapshotConfig -CreateOption Empty -Location 'Central US' -SourceUri 'https://contosoaccount.blob.core.windows.net/vhdstore/win7baseimage.vhd'
```

Expand Down
3 changes: 2 additions & 1 deletion src/Compute/Compute/help/New-AzVMDataDisk.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,8 @@ The final command updates the Vmss VM by adding a new data disk.

Creates a local data disk object for a virtual machine or a Vmss VM. (autogenerated)

```powershell <!-- Aladdin Generated Example -->
<!-- Aladdin Generated Example -->
```powershell
New-AzVMDataDisk -Caching None -CreateOption Attach -DiskSizeInGB 1 -Lun 2 -Name 'AgentPool01'
```

Expand Down
2 changes: 1 addition & 1 deletion src/Compute/Compute/help/New-AzVmssConfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,8 +84,8 @@ uses the VMSS configuration object created in the first command.

Creates a VMSS configuration object. (autogenerated)

<!-- Aladdin Generated Example -->
```powershell
<!-- Aladdin Generated Example -->
New-AzVmssConfig -Location <String> -Overprovision $false -SkuCapacity 2 -SkuName 'Standard_A0' -Tag @{key0="value0";key1=$null;key2="value2"} -UpgradePolicyMode Automatic;
```

Expand Down
3 changes: 2 additions & 1 deletion src/Compute/Compute/help/Remove-AzProximityPlacementGroup.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@ This command removes the given proximity placement group.

This command removes the given proximity placement group. (autogenerated)

```powershell <!-- Aladdin Generated Example -->
<!-- Aladdin Generated Example -->
```powershell
Remove-AzProximityPlacementGroup -Name 'AgentPool01' -ResourceGroupName myresourcegroup
```

Expand Down
3 changes: 2 additions & 1 deletion src/Compute/Compute/help/Remove-AzVMAccessExtension.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ The **Remove-AzVMAccessExtension** cmdlet removes the Virtual Machine Access (VM

Removes the VMAccess extension from a virtual machine. (autogenerated)

```powershell <!-- Aladdin Generated Example -->
<!-- Aladdin Generated Example -->
```powershell
Remove-AzVMAccessExtension -Name 'AgentPool01' -ResourceGroupName myresourcegroup -VMName 'VM01'
```

Expand Down
3 changes: 2 additions & 1 deletion src/Compute/Compute/help/Remove-AzVMCustomScriptExtension.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ The **Remove-AzVMCustomScriptExtension** cmdlet removes a custom script Virtual

Removes a custom script extension from a virtual machine. (autogenerated)

```powershell <!-- Aladdin Generated Example -->
<!-- Aladdin Generated Example -->
```powershell
Remove-AzVMCustomScriptExtension -Name 'AgentPool01' -ResourceGroupName myresourcegroup -VMName 'VM01'
```

Expand Down
Loading

0 comments on commit 344958f

Please sign in to comment.