Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-Help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems xmlns="http://msh" schema="maml"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Add-AzureRmApiManagementApiToProduct</command:name> <command:verb>Add</command:verb> <command:noun>AzureRmApiManagementApiToProduct</command:noun> <maml:description><maml:para>Adds an API to a product. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Add-AzureRmApiManagementApiToProduct cmdlet adds an Azure API Management API to a product. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Add-AzureRmApiManagementApiToProduct</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies the ID of an API to add to a product. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductId</maml:name> <maml:Description><maml:para>Specifies the ID of the product to which to add the API. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies the ID of an API to add to a product. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductId</maml:name> <maml:Description><maml:para>Specifies the ID of the product to which to add the API. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Boolean</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Add an API to a product</maml:title> <dev:code>PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Add-AzureRmApiManagementApiToProduct -Context $ApiMgmtContext -ProductId "0123456789" -ApiId "0001"</dev:code> <dev:remarks><maml:para>This command adds the specified API to the specified product. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/add-azurermapimanagementapitoproduct</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementApiFromProduct</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Add-AzureRmApiManagementProductToGroup</command:name> <command:verb>Add</command:verb> <command:noun>AzureRmApiManagementProductToGroup</command:noun> <maml:description><maml:para>Adds a product to a group. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Add-AzureRmApiManagementProductToGroup cmdlet adds a product to an existing group. In other words, this cmdlet assigns a group to a product. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Add-AzureRmApiManagementProductToGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>GroupId</maml:name> <maml:Description><maml:para>Specifies the group ID. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductId</maml:name> <maml:Description><maml:para>Specifies the product ID. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>GroupId</maml:name> <maml:Description><maml:para>Specifies the group ID. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductId</maml:name> <maml:Description><maml:para>Specifies the product ID. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Boolean</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Add a product to a group</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Add-AzureRmApiManagementProductToGroup -Context $apimContext -GroupId "0001" -ProductId "0123456789"</dev:code> <dev:remarks><maml:para>This command adds a product to an existing group. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/add-azurermapimanagementproducttogroup</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementProductFromGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Add-AzureRmApiManagementUserToGroup</command:name> <command:verb>Add</command:verb> <command:noun>AzureRmApiManagementUserToGroup</command:noun> <maml:description><maml:para>Adds a user to a group. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Add-AzureRmApiManagementUserToGroup cmdlet adds a user to a group. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Add-AzureRmApiManagementUserToGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>GroupId</maml:name> <maml:Description><maml:para>Specifies the group ID. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>UserId</maml:name> <maml:Description><maml:para>Specifies the user ID. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>GroupId</maml:name> <maml:Description><maml:para>Specifies the group ID. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>UserId</maml:name> <maml:Description><maml:para>Specifies the user ID. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Boolean</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Add a user to a group</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Add-AzureRmApiManagementUserToGroup -Context $apimContext -GroupId "0001" -UserId "0123456789"</dev:code> <dev:remarks><maml:para>This command adds an existing user to an existing group. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/add-azurermapimanagementusertogroup</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementUserFromGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Export-AzureRmApiManagementApi</command:name> <command:verb>Export</command:verb> <command:noun>AzureRmApiManagementApi</command:noun> <maml:description><maml:para>Exports an API to a file. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Export-AzureRmApiManagementApi cmdlet exports an Azure API Management API to a file in one of the supported formats. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Export-AzureRmApiManagementApi</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies the ID of the API to export. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Indicates that this operation overwrites the file of the same name if it already exists. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this operation returns $True if the API is exported successfully, or $False otherwise. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SaveAs</maml:name> <maml:Description><maml:para>Specifies the file path to which to save the exported API. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SpecificationFormat</maml:name> <maml:Description><maml:para>Specifies the API format. psdx_paramvalues Wadl and Swagger. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Wadl</command:parameterValue> <command:parameterValue required="false" variableLength="false">Swagger</command:parameterValue> <command:parameterValue required="false" variableLength="false">Wsdl</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PsApiManagementApiFormat</command:parameterValue> <dev:type><maml:name>PsApiManagementApiFormat</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies the ID of the API to export. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Indicates that this operation overwrites the file of the same name if it already exists. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this operation returns $True if the API is exported successfully, or $False otherwise. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SaveAs</maml:name> <maml:Description><maml:para>Specifies the file path to which to save the exported API. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SpecificationFormat</maml:name> <maml:Description><maml:para>Specifies the API format. psdx_paramvalues Wadl and Swagger. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementApiFormat</command:parameterValue> <dev:type><maml:name>PsApiManagementApiFormat</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>String</maml:name> </dev:type> <maml:description><maml:para>This cmdlet returns the exported API content as a string. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Export an API in Web Application Description Language (WADL) format</maml:title> <dev:code>PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Export-AzureRmApiManagementApi -Context $ApiMgmtContext -ApiId "0123456789" -SpecificationFormat "Wadl" -SaveAs "C:\contoso\specifications\0123456789.wadl"</dev:code> <dev:remarks><maml:para>This command exports an API to a WADL file. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/export-azurermapimanagementapi</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Import-AzureRmApiManagementApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmApiManagementApi</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmApiManagementApi</command:noun> <maml:description><maml:para>Gets an API. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmApiManagementApi cmdlet gets one or more Azure API Management APIs. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmApiManagementApi</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies the ID of the API to get. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Get-AzureRmApiManagementApi</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the API to get. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Get-AzureRmApiManagementApi</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductId</maml:name> <maml:Description><maml:para>Specifies the ID of the product for which to get the API. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies the ID of the API to get. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the API to get. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductId</maml:name> <maml:Description><maml:para>Specifies the ID of the product for which to get the API. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi</maml:name> </dev:type> <maml:description><maml:para>The details of the Api in a given ApiManagement service </maml:para> </maml:description> </command:returnValue> <command:returnValue><dev:type><maml:name>IList<Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi></maml:name> </dev:type> <maml:description><maml:para>The list of Apis in a given ApiManagement service </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get all management APIs</maml:title> <dev:code>PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementApi -Context $ApiMgmtContext</dev:code> <dev:remarks><maml:para>This command gets all of the APIs for the specified context. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Get a management API by ID</maml:title> <dev:code>PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementApi -Context $ApiMgmtContext -ApiId $ApiId</dev:code> <dev:remarks><maml:para>This command gets the API with the specified ID. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 3: Get a management API by name</maml:title> <dev:code>PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementApi -Context $ApiMgmtContext -Name "EchoApi"</dev:code> <dev:remarks><maml:para>This command gets the API with the specified name. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementapi</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Export-AzureRmApiManagementApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Import-AzureRmApiManagementApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmApiManagementAuthorizationServer</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmApiManagementAuthorizationServer</command:noun> <maml:description><maml:para>Gets an API Management authorization server. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmApiManagementAuthorizationServer cmdlet gets all Azure API Management authorization servers or specified authorization servers. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmApiManagementAuthorizationServer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para> </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ServerId</maml:name> <maml:Description><maml:para> </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para> </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ServerId</maml:name> <maml:Description><maml:para> </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOAuth2AuthrozationServer</maml:name> </dev:type> <maml:description><maml:para>The details of the Authorization Server in a given Api Management service. </maml:para> </maml:description> </command:returnValue> <command:returnValue><dev:type><maml:name>IList<Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOAuth2AuthrozationServer></maml:name> </dev:type> <maml:description><maml:para>The list of Authorization Server in a given Api Management service. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get all authorization servers</maml:title> <dev:code>PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementAuthrizarionServer -Context $ApiMgmtContext</dev:code> <dev:remarks><maml:para>This command gets all API Management authorization servers. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Get a specified authorization server</maml:title> <dev:code>PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementCertificate -Context $ApiMgmtContext -ServerId "0123456789"</dev:code> <dev:remarks><maml:para>This command gets the specified authorization server. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementauthorizationserver</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementAuthorizationServer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementAuthorizationServer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementAuthorizationServer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmApiManagementBackend</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmApiManagementBackend</command:noun> <maml:description><maml:para>Get the details of the Backend. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Get the details of the Backend. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmApiManagementBackend</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>BackendId</maml:name> <maml:Description><maml:para>Identifier of a backend. If specified will try to find backend by the identifier. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Instance of PsApiManagementContext. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>BackendId</maml:name> <maml:Description><maml:para>Identifier of a backend. If specified will try to find backend by the identifier. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Instance of PsApiManagementContext. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackend</maml:name> </dev:type> <maml:description><maml:para>The details of the Backend configured in API Management service. </maml:para> </maml:description> </command:returnValue> <command:returnValue><dev:type><maml:name>IList<Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackend></maml:name> </dev:type> <maml:description><maml:para>The list of Backend configured in API Management service. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get all Backends</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementBackend -Context $apimContext</dev:code> <dev:remarks><maml:para>Gets a list of all the Backends configured in the Api Management service. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Get the Backend specified by the Identifier 123</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementBackend -Context $apimContext -backendId 123</dev:code> <dev:remarks><maml:para>Get the details of the specified Backend identified by the Identifier '123' </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementbackend</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementBackend</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementBackendCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementBackendProxy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementBackend</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementBackend</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmApiManagementCertificate</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmApiManagementCertificate</command:noun> <maml:description><maml:para>Gets API Management certificates configured for Mutual Authentication with Backend in the service. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmApiManagementCertificate cmdlet gets all Azure API Management certificates or certificates that you specify. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmApiManagementCertificate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>CertificateId</maml:name> <maml:Description><maml:para>Specifies the ID of the certificate to get. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>CertificateId</maml:name> <maml:Description><maml:para>Specifies the ID of the certificate to get. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementCertificate</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get all certificates</maml:title> <dev:code>PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementCertificate -Context $ApiMgmtContext</dev:code> <dev:remarks><maml:para>This command gets all API Management certificates. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Get a certificate by its ID</maml:title> <dev:code>PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementCertificate -Context $ApiMgmtContext -CertificateId "0123456789"</dev:code> <dev:remarks><maml:para>This command gets the API Management certificate with the specified ID. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementcertificate</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmApiManagementGroup</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmApiManagementGroup</command:noun> <maml:description><maml:para>Gets all or specific API management groups. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmApiManagementGroup cmdlet gets all or specific API management groups. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmApiManagementGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies an instance of PsApiManagementContext. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>GroupId</maml:name> <maml:Description><maml:para>Specifies the group ID. If specified, the cmdlet attempts to find the group by the identifier. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the management group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Get-AzureRmApiManagementGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies an instance of PsApiManagementContext. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the management group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductId</maml:name> <maml:Description><maml:para>Identifier of existing product. If specified will return all groups the product assigned to. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Get-AzureRmApiManagementGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies an instance of PsApiManagementContext. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the management group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>UserId</maml:name> <maml:Description><maml:para>Specifies the identifier of existing product. If specified the cmdlet will return all groups the product assigned to. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies an instance of PsApiManagementContext. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>GroupId</maml:name> <maml:Description><maml:para>Specifies the group ID. If specified, the cmdlet attempts to find the group by the identifier. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the management group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductId</maml:name> <maml:Description><maml:para>Identifier of existing product. If specified will return all groups the product assigned to. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>UserId</maml:name> <maml:Description><maml:para>Specifies the identifier of existing product. If specified the cmdlet will return all groups the product assigned to. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGroup</maml:name> </dev:type> <maml:description><maml:para>The details of the Group configured in API Management service. </maml:para> </maml:description> </command:returnValue> <command:returnValue><dev:type><maml:name>IList<Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGroup></maml:name> </dev:type> <maml:description><maml:para>The list of Groups configured in API Management service. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get all groups</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementGroup -Context $apimContext</dev:code> <dev:remarks><maml:para>This command gets all groups. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Get a group by ID</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementGroup -Context $apimContext -GroupId "0123456789"</dev:code> <dev:remarks><maml:para>This command gets the group ID named 0123456789. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 3: Get a group by name</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementGroup -Context $apimContext -Name "Group0002"</dev:code> <dev:remarks><maml:para>This command gets the group named Group0002. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 4: Get all user groups</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementGroup -Context $apimContext -UserId "0123456789"</dev:code> <dev:remarks><maml:para>This command gets all user groups with the user ID named 0123456789. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementgroup</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmApiManagementIdentityProvider</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmApiManagementIdentityProvider</command:noun> <maml:description><maml:para>Get the identity provider configuration details. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Get the identity provider configuration details. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmApiManagementIdentityProvider</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Instance of PsApiManagementContext. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Type</maml:name> <maml:Description><maml:para>Identifier of a Identity Provider. If specified will try to find identity provider configuration by the identifier. This parameter is optional. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Facebook</command:parameterValue> <command:parameterValue required="false" variableLength="false">Google</command:parameterValue> <command:parameterValue required="false" variableLength="false">Microsoft</command:parameterValue> <command:parameterValue required="false" variableLength="false">Twitter</command:parameterValue> <command:parameterValue required="false" variableLength="false">Aad</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PsApiManagementIdentityProviderType</command:parameterValue> <dev:type><maml:name>PsApiManagementIdentityProviderType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Instance of PsApiManagementContext. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Type</maml:name> <maml:Description><maml:para>Identifier of a Identity Provider. If specified will try to find identity provider configuration by the identifier. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementIdentityProviderType</command:parameterValue> <dev:type><maml:name>PsApiManagementIdentityProviderType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProvider</maml:name> </dev:type> <maml:description><maml:para>The details of the Identity Provider configured in API Management service. </maml:para> </maml:description> </command:returnValue> <command:returnValue><dev:type><maml:name>IList<Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProvider></maml:name> </dev:type> <maml:description><maml:para>The list of Identity Providers configured in API Management service. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get all Identity Providers</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementIdentityProvider -Context $apimContext</dev:code> <dev:remarks><maml:para>Get all the identity provider Configuration on the service. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Get the AAD Type Identity Provider</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementIdentityProvider -Context $apimContext -Type Aad</dev:code> <dev:remarks><maml:para>Gets the Identity Provider Configuration of Azure Active Directory. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementidentityprovider</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmApiManagementLogger</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmApiManagementLogger</command:noun> <maml:description><maml:para>Gets API Management Logger objects. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmApiManagementLogger cmdlet gets an Azure API Management Logger or all the loggers. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmApiManagementLogger</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>LoggerId</maml:name> <maml:Description><maml:para>Specifies the ID of the specific logger to get. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>LoggerId</maml:name> <maml:Description><maml:para>Specifies the ID of the specific logger to get. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementLogger</maml:name> </dev:type> <maml:description><maml:para>The detail of the Logger configured in API Management service. </maml:para> </maml:description> </command:returnValue> <command:returnValue><dev:type><maml:name>IList<Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementLogger></maml:name> </dev:type> <maml:description><maml:para>The list of Loggers configured in API Management service. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get all loggers</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementLogger -Context $apimContext</dev:code> <dev:remarks><maml:para>This command gets all the loggers for the specified context. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Get a specific logger</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementLogger -Context $apimContext -LoggerId "Logger123"</dev:code> <dev:remarks><maml:para>This command removes a logger that has the ID Logger123. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementlogger</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementLogger</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementLogger</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementLogger</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmApiManagementOpenIdConnectProvider</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmApiManagementOpenIdConnectProvider</command:noun> <maml:description><maml:para>Gets OpenID Connect providers. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmApiManagementOpenIdConnectProvider cmdlet gets OpenID Connect providers in Azure API Management. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmApiManagementOpenIdConnectProvider</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies a friendly name of a provider. If you specify a name, this cmdlet gets that provider. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Get-AzureRmApiManagementOpenIdConnectProvider</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OpenIdConnectProviderId</maml:name> <maml:Description><maml:para>Specifies an ID of the provider that this cmdlet removes. If you specify an ID, this cmdlet gets that provider. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies a friendly name of a provider. If you specify a name, this cmdlet gets that provider. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OpenIdConnectProviderId</maml:name> <maml:Description><maml:para>Specifies an ID of the provider that this cmdlet removes. If you specify an ID, this cmdlet gets that provider. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOpenIdConnectProvider</maml:name> </dev:type> <maml:description><maml:para>The detail of the OpenId connect Provider configured in API Management service. </maml:para> </maml:description> </command:returnValue> <command:returnValue><dev:type><maml:name>IList<Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOpenIdConnectProvider></maml:name> </dev:type> <maml:description><maml:para>The list of OpenId Connect Providers configured in API Management service. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get all providers</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementOpenIdConnectProvider -Context $apimContext</dev:code> <dev:remarks><maml:para>This command gets all OpenID Connect providers for the specified context. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Get a provider by using an ID</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementOpenIdConnectProvider -Context $apimContext -OpenIdConnectProviderId "OICProvicer01"</dev:code> <dev:remarks><maml:para>This command gets the provider that has the ID OICProvicer01. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 3: Get a provider by using a name</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementOpenIdConnectProvider -Context $apimContext -Name "Contoso OpenID Connect Provider"</dev:code> <dev:remarks><maml:para>This command gets the provider named Contoso OpenID Connect Provider. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementopenidconnectprovider</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementOpenIdConnectProvider</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementOpenIdConnectProvider</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementOpenIdConnectProvider</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmApiManagementOperation</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmApiManagementOperation</command:noun> <maml:description><maml:para>Gets a list or a specified API Operation. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmApiManagementOperation gets a list or a specified API Operation. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmApiManagementOperation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies the identifier of the API Operation. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies the instance of the PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OperationId</maml:name> <maml:Description><maml:para>Specifies the operation identifier. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies the identifier of the API Operation. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies the instance of the PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OperationId</maml:name> <maml:Description><maml:para>Specifies the operation identifier. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOperation</maml:name> </dev:type> <maml:description><maml:para>The details of the API Operation in Api Management service. </maml:para> </maml:description> </command:returnValue> <command:returnValue><dev:type><maml:name>IList<Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOperation></maml:name> </dev:type> <maml:description><maml:para>The list of API Operation in Api Management service. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get all API management operations</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementOperation -Context $apimContext -ApiId $APIId</dev:code> <dev:remarks><maml:para>This command gets all API management operations. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Get an API Management operation by operation ID</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementOperation -Context $apimContext -ApiId $APIId -OperationId "Operation003"</dev:code> <dev:remarks><maml:para>This command gets an API management operation by operation ID named Operation0003. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementoperation</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementOperation</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementOperation</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementOperation</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmApiManagementPolicy</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmApiManagementPolicy</command:noun> <maml:description><maml:para>Gets the specified scope policy. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmApiManagementPolicy cmdlet gets the specified scope policy. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmApiManagementPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies the identifier of the existing API. If you specify this parameter the cmdlet returns the API-scope policy. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies an instance of PsApiManagementContext . </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>ps_force </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Format</maml:name> <maml:Description><maml:para>Specifies the format of the API management policy. The default value for this parameter is "application/vnd.ms-azure-apim.policy+xml". </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SaveAs</maml:name> <maml:Description><maml:para>Specifies the file path to save the result to. If you do not specify this parameter the result is pipelined as a sting. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Get-AzureRmApiManagementPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies the identifier of the existing API. If you specify this parameter the cmdlet returns the API-scope policy. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies an instance of PsApiManagementContext . </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>ps_force </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Format</maml:name> <maml:Description><maml:para>Specifies the format of the API management policy. The default value for this parameter is "application/vnd.ms-azure-apim.policy+xml". </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OperationId</maml:name> <maml:Description><maml:para>Specifies the identifier of the existing API operation. If you specify this parameter with ApiId the cmdlet returns operation-scope policy. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SaveAs</maml:name> <maml:Description><maml:para>Specifies the file path to save the result to. If you do not specify this parameter the result is pipelined as a sting. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Get-AzureRmApiManagementPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies an instance of PsApiManagementContext . </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>ps_force </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Format</maml:name> <maml:Description><maml:para>Specifies the format of the API management policy. The default value for this parameter is "application/vnd.ms-azure-apim.policy+xml". </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductId</maml:name> <maml:Description><maml:para>Specifies the identifier of an existing product. If you specify this parameter the cmdlet returns the product-scope policy. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SaveAs</maml:name> <maml:Description><maml:para>Specifies the file path to save the result to. If you do not specify this parameter the result is pipelined as a sting. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies the identifier of the existing API. If you specify this parameter the cmdlet returns the API-scope policy. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies an instance of PsApiManagementContext . </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>ps_force </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Format</maml:name> <maml:Description><maml:para>Specifies the format of the API management policy. The default value for this parameter is "application/vnd.ms-azure-apim.policy+xml". </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OperationId</maml:name> <maml:Description><maml:para>Specifies the identifier of the existing API operation. If you specify this parameter with ApiId the cmdlet returns operation-scope policy. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductId</maml:name> <maml:Description><maml:para>Specifies the identifier of an existing product. If you specify this parameter the cmdlet returns the product-scope policy. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SaveAs</maml:name> <maml:Description><maml:para>Specifies the file path to save the result to. If you do not specify this parameter the result is pipelined as a sting. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>String</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get the tenant level policy</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementPolicy -Context $apimContext -SaveAs "C:\contoso\policies\tenantpolicy.xml"</dev:code> <dev:remarks><maml:para>This command gets tenant level policy and saves it to a file named tenantpolicy.xml. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Get the product-scope policy</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementPolicy -Context $apimContext -ProductId "0123456789"</dev:code> <dev:remarks><maml:para>This command gets product-scope policy </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 3: Get the API-scope policy</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementPolicy -Context $apimContext -ApiId "9876543210"</dev:code> <dev:remarks><maml:para>This command gets API-scope policy. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 4: Get the operation-scope policy</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementPolicy -Context $apimContext -ApiId "9876543210" -OperationId "777"</dev:code> <dev:remarks><maml:para>This command gets the operation-scope policy. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementpolicy</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmApiManagementProduct</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmApiManagementProduct</command:noun> <maml:description><maml:para>Gets a list or a particular product. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmApiManagementProduct cmdlet gets a list or a particular product. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmApiManagementProduct</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies an instance of a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductId</maml:name> <maml:Description><maml:para>Specifies the identifier of the product to search for. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Get-AzureRmApiManagementProduct</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies an instance of a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Title</maml:name> <maml:Description><maml:para>Specifies the title of the product to look for. If specified, the cmdlet attempts to get the product by title. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies an instance of a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductId</maml:name> <maml:Description><maml:para>Specifies the identifier of the product to search for. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Title</maml:name> <maml:Description><maml:para>Specifies the title of the product to look for. If specified, the cmdlet attempts to get the product by title. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProduct</maml:name> </dev:type> <maml:description><maml:para>The details of the Product in API Management service. </maml:para> </maml:description> </command:returnValue> <command:returnValue><dev:type><maml:name>IList<Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProduct></maml:name> </dev:type> <maml:description><maml:para>The list of Product in API Management service. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get all products</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementProduct -Context $apimContext</dev:code> <dev:remarks><maml:para>This command get all API Management products. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Get a product by ID</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementProduct -Context $apimContext -ProductId "0123456789"</dev:code> <dev:remarks><maml:para>This command get an API Management product by ID. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementproduct</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementProduct</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementProduct</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementProduct</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmApiManagementProperty</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmApiManagementProperty</command:noun> <maml:description><maml:para> </maml:para> </maml:description> </command:details> <maml:description><maml:para> </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmApiManagementProperty</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para> </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para> </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Get-AzureRmApiManagementProperty</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para> </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PropertyId</maml:name> <maml:Description><maml:para> </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Get-AzureRmApiManagementProperty</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para> </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Tag</maml:name> <maml:Description><maml:para>Key-value pairs in the form of a hash table. For example: </maml:para> <maml:para>@{key0="value0";key1=$null;key2="value2"} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para> </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para> </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PropertyId</maml:name> <maml:Description><maml:para> </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Tag</maml:name> <maml:Description><maml:para>Key-value pairs in the form of a hash table. For example: </maml:para> <maml:para>@{key0="value0";key1=$null;key2="value2"} </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>System.Collections.Generic.IList`1[Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProperty]</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> <command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProperty</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get Property by name</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementProperty -Context $apimContext -Name "sql-connectionstring"</dev:code> <dev:remarks><maml:para> </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementproperty</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmApiManagementSubscription</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmApiManagementSubscription</command:noun> <maml:description><maml:para>Gets subscriptions. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmApiManagementSubscription cmdlet gets a specified subscription, or all subscriptions, if no subscription is specified. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmApiManagementSubscription</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductId</maml:name> <maml:Description><maml:para>Specifies a product identifier. If specified, this cmdlet finds all subscriptions by the product identifier. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Get-AzureRmApiManagementSubscription</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SubscriptionId</maml:name> <maml:Description><maml:para>Specifies a subscription identifier. If specified, this cmdlet finds subscription by the identifier. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Get-AzureRmApiManagementSubscription</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>UserId</maml:name> <maml:Description><maml:para>Specifies a user identifier. If specified, this cmdlet finds all subscriptions by the user identifier. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductId</maml:name> <maml:Description><maml:para>Specifies a product identifier. If specified, this cmdlet finds all subscriptions by the product identifier. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SubscriptionId</maml:name> <maml:Description><maml:para>Specifies a subscription identifier. If specified, this cmdlet finds subscription by the identifier. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>UserId</maml:name> <maml:Description><maml:para>Specifies a user identifier. If specified, this cmdlet finds all subscriptions by the user identifier. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscription</maml:name> </dev:type> <maml:description><maml:para>The detail of the subscription in the API Management service. </maml:para> </maml:description> </command:returnValue> <command:returnValue><dev:type><maml:name>IList<Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscription></maml:name> </dev:type> <maml:description><maml:para>The list of subscription in API Management service. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get all subscriptions</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementSubscription -Context $apimContext</dev:code> <dev:remarks><maml:para>This command gets all subscriptions. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Get a subscription with a specified ID</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementSubscription -Context $apimContext -SubscriptionId "0123456789"</dev:code> <dev:remarks><maml:para>This command gets a subscription by ID. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 3: Get all subscriptions for a user</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementSubscription -Context $apimContext -UserId "777"</dev:code> <dev:remarks><maml:para>This command gets a user's subscriptions. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 4: Get all subscriptions for a product</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementSubscription -Context $apimContext -ProductId "999"</dev:code> <dev:remarks><maml:para>This command gets all subscriptions for the product. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementsubscription</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementSubscription</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementSubscription</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementSubscription</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmApiManagementTenantAccess</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmApiManagementTenantAccess</command:noun> <maml:description><maml:para>Gets the access configuration for a tenant. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmApiManagementTenantAccess cmdlet gets the tenant access configuration for a tenant. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmApiManagementTenantAccess</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAccessInformation</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get tenant access configuration</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementTenantAccess -Context $apimContext</dev:code> <dev:remarks><maml:para>This command gets the tenant access configuration for the specified context. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementtenantaccess</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementTenantAccess</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmApiManagementTenantGitAccess</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmApiManagementTenantGitAccess</command:noun> <maml:description><maml:para>Gets the Git access configuration for a tenant. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmApiManagementTenantGitAccess cmdlet gets the Git access configuration for a tenant. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmApiManagementTenantGitAccess</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAccessInformation</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get tenant access configuration</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementTenantGitAccess -Context $apimContext</dev:code> <dev:remarks><maml:para>This command gets the Git access configuration for the specified context. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementtenantgitaccess</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmApiManagementTenantSyncState</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmApiManagementTenantSyncState</command:noun> <maml:description><maml:para>Gets the status of the most recent synchronization between the configuration database and the Git repository. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmApiManagementTenantSyncState cmdlet gets the status of the most recent synchronization between the configuration database and the Git repository. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmApiManagementTenantSyncState</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAccessInformation</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get the status of the most recent synchronization</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementTenantSyncState -Context $apimContext</dev:code> <dev:remarks><maml:para>This command gets the status of the most recent synchronization between the configuration database and the Git repository. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementtenantsyncstate</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmApiManagementUser</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmApiManagementUser</command:noun> <maml:description><maml:para>Gets a user or users. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmApiManagementUser cmdlet gets a specified user, or all users, if no user is specified. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmApiManagementUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies an instance of PsApiManagementContext . </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Email</maml:name> <maml:Description><maml:para>Specifies the email address of the user. If this parameter is specified, this cmdlet finds a user by email. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>FirstName</maml:name> <maml:Description><maml:para>Specifies the first name of the user. If this parameter is specified, this cmdlet finds a user by first name. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>GroupId</maml:name> <maml:Description><maml:para>Specifies the group identifier. If specified, this cmdlet finds all users within the specified group. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>LastName</maml:name> <maml:Description><maml:para>Specifies the last name of a user. If specified, this cmdlet finds users by last name. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>State</maml:name> <maml:Description><maml:para>Specifies the user state. If specified, this cmdlet finds users in this state. This parameter is optional. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Blocked</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PsApiManagementUserState</command:parameterValue> <dev:type><maml:name>PsApiManagementUserState</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Get-AzureRmApiManagementUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies an instance of PsApiManagementContext . </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>UserId</maml:name> <maml:Description><maml:para>Specifies a user ID. If specified, this cmdlet finds the user by this identifier. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies an instance of PsApiManagementContext . </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Email</maml:name> <maml:Description><maml:para>Specifies the email address of the user. If this parameter is specified, this cmdlet finds a user by email. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>FirstName</maml:name> <maml:Description><maml:para>Specifies the first name of the user. If this parameter is specified, this cmdlet finds a user by first name. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>GroupId</maml:name> <maml:Description><maml:para>Specifies the group identifier. If specified, this cmdlet finds all users within the specified group. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>LastName</maml:name> <maml:Description><maml:para>Specifies the last name of a user. If specified, this cmdlet finds users by last name. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>State</maml:name> <maml:Description><maml:para>Specifies the user state. If specified, this cmdlet finds users in this state. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementUserState</command:parameterValue> <dev:type><maml:name>PsApiManagementUserState</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>UserId</maml:name> <maml:Description><maml:para>Specifies a user ID. If specified, this cmdlet finds the user by this identifier. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUser</maml:name> </dev:type> <maml:description><maml:para>The details of User in API Management service. </maml:para> </maml:description> </command:returnValue> <command:returnValue><dev:type><maml:name>IList<Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUser></maml:name> </dev:type> <maml:description><maml:para>The list of User in the API Management service. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get all users</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementUser -Context $apimContext</dev:code> <dev:remarks><maml:para>This command gets all users. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Get a user by ID</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementUser -Context $apimContext -UserId "0123456789"</dev:code> <dev:remarks><maml:para>This command gets a user by ID. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example: Get users by last name</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementUser -Context $apimContext -LastName "Fuller"</dev:code> <dev:remarks><maml:para>This command gets users that have a specified last name, Fuller. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 4: Get a user by email address</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementUser -Context $apimContext -Email "user@contoso.com"</dev:code> <dev:remarks><maml:para>This command gets the user that has the specified email address. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 5: Get all users within a group</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementUser -Context $apimContext -GroupId "0001"</dev:code> <dev:remarks><maml:para>This command gets all users within the specified group. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementuser</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Get-AzureRmApiManagementUserSsoUrl</command:name> <command:verb>Get</command:verb> <command:noun>AzureRmApiManagementUserSsoUrl</command:noun> <maml:description><maml:para>Generates an SSO URL for a user. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Get-AzureRmApiManagementUserSsoUrl cmdlet generates a single sign-on (SSO) URL for a user. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Get-AzureRmApiManagementUserSsoUrl</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>UserId</maml:name> <maml:Description><maml:para>Specifies a user ID. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>UserId</maml:name> <maml:Description><maml:para>Specifies a user ID. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>string</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Get a user's SSO URL</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementUserSsoUrl -Context $apimContext -UserId "0123456789"</dev:code> <dev:remarks><maml:para>This command gets a user's SSO URL. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/get-azurermapimanagementuserssourl</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Import-AzureRmApiManagementApi</command:name> <command:verb>Import</command:verb> <command:noun>AzureRmApiManagementApi</command:noun> <maml:description><maml:para>Imports an API from a file or a URL. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Import-AzureRmApiManagementApi cmdlet imports an Azure API Management API from a file or a URL in Web Application Description Language (WADL), Web Services Description Language (WSDL), or Swagger format. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Import-AzureRmApiManagementApi</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies an ID for the API to import. If you do not specify this parameter, an ID is generated for you. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiType</maml:name> <maml:Description><maml:para>This parameter is optional with a default value of Http. The Soap option is only applicable when importing WSDL and will create a SOAP Passthrough API. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Http</command:parameterValue> <command:parameterValue required="false" variableLength="false">Soap</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PsApiManagementApiType</command:parameterValue> <dev:type><maml:name>PsApiManagementApiType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Path</maml:name> <maml:Description><maml:para>Specifies a web API path as the last part of the API's public URL. This URL is used by API consumers for sending requests to the web service. Must be 1 to 400 characters long. The default value is $Null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SpecificationFormat</maml:name> <maml:Description><maml:para>Specifies the specification format. psdx_paramvalues Wadl, Wsdl, and Swagger. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Wadl</command:parameterValue> <command:parameterValue required="false" variableLength="false">Swagger</command:parameterValue> <command:parameterValue required="false" variableLength="false">Wsdl</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PsApiManagementApiFormat</command:parameterValue> <dev:type><maml:name>PsApiManagementApiFormat</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SpecificationPath</maml:name> <maml:Description><maml:para>Specifies the specification file path. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>WsdlEndpointName</maml:name> <maml:Description><maml:para>Local name of WSDL Endpoint (port) to be imported. Must be 1 to 400 characters long. This parameter is optional and only required for importing Wsdl. Default value is $null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>WsdlServiceName</maml:name> <maml:Description><maml:para>Local name of WSDL Service to be imported. Must be 1 to 400 characters long. This parameter is optional and only required for importing Wsdl . Default value is $null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Import-AzureRmApiManagementApi</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies an ID for the API to import. If you do not specify this parameter, an ID is generated for you. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiType</maml:name> <maml:Description><maml:para>This parameter is optional with a default value of Http. The Soap option is only applicable when importing WSDL and will create a SOAP Passthrough API. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Http</command:parameterValue> <command:parameterValue required="false" variableLength="false">Soap</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PsApiManagementApiType</command:parameterValue> <dev:type><maml:name>PsApiManagementApiType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Path</maml:name> <maml:Description><maml:para>Specifies a web API path as the last part of the API's public URL. This URL is used by API consumers for sending requests to the web service. Must be 1 to 400 characters long. The default value is $Null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SpecificationFormat</maml:name> <maml:Description><maml:para>Specifies the specification format. psdx_paramvalues Wadl, Wsdl, and Swagger. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Wadl</command:parameterValue> <command:parameterValue required="false" variableLength="false">Swagger</command:parameterValue> <command:parameterValue required="false" variableLength="false">Wsdl</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PsApiManagementApiFormat</command:parameterValue> <dev:type><maml:name>PsApiManagementApiFormat</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SpecificationUrl</maml:name> <maml:Description><maml:para>Specifies the specification URL. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>WsdlEndpointName</maml:name> <maml:Description><maml:para>Local name of WSDL Endpoint (port) to be imported. Must be 1 to 400 characters long. This parameter is optional and only required for importing Wsdl. Default value is $null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>WsdlServiceName</maml:name> <maml:Description><maml:para>Local name of WSDL Service to be imported. Must be 1 to 400 characters long. This parameter is optional and only required for importing Wsdl . Default value is $null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies an ID for the API to import. If you do not specify this parameter, an ID is generated for you. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiType</maml:name> <maml:Description><maml:para>This parameter is optional with a default value of Http. The Soap option is only applicable when importing WSDL and will create a SOAP Passthrough API. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementApiType</command:parameterValue> <dev:type><maml:name>PsApiManagementApiType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Path</maml:name> <maml:Description><maml:para>Specifies a web API path as the last part of the API's public URL. This URL is used by API consumers for sending requests to the web service. Must be 1 to 400 characters long. The default value is $Null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SpecificationFormat</maml:name> <maml:Description><maml:para>Specifies the specification format. psdx_paramvalues Wadl, Wsdl, and Swagger. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementApiFormat</command:parameterValue> <dev:type><maml:name>PsApiManagementApiFormat</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SpecificationPath</maml:name> <maml:Description><maml:para>Specifies the specification file path. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SpecificationUrl</maml:name> <maml:Description><maml:para>Specifies the specification URL. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>WsdlEndpointName</maml:name> <maml:Description><maml:para>Local name of WSDL Endpoint (port) to be imported. Must be 1 to 400 characters long. This parameter is optional and only required for importing Wsdl. Default value is $null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>WsdlServiceName</maml:name> <maml:Description><maml:para>Local name of WSDL Service to be imported. Must be 1 to 400 characters long. This parameter is optional and only required for importing Wsdl . Default value is $null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi</maml:name> </dev:type> <maml:description><maml:para>This cmdlet returns the imported API as a PsApiManagementApi object. </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1 Import an API from a WADL file</maml:title> <dev:code>PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Import-AzureRmApiManagementApi -Context $ApiMgmtContext -SpecificationFormat "Wadl" -SpecificationPath "C:\contoso\specifications\echoapi.wadl" -Path "apis"</dev:code> <dev:remarks><maml:para>This command imports an API from the specified WADL file. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2 Import an API from a Swagger file</maml:title> <dev:code>PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Import-AzureRmApiManagementApi -Context $ApiMgmtContext -SpecificationFormat "Swagger" -SpecificationPath "C:\contoso\specifications\echoapi.swagger" -Path "apis"</dev:code> <dev:remarks><maml:para>This command imports an API from the specified Swagger file. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 3: Import an API from a WADL link</maml:title> <dev:code>PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Import-AzureRmApiManagementApi -Context $ApiMgmtContext -SpecificationFormat "Wadl" -SpecificationUrl "http://contoso.com/specifications/wadl/echoapi" -Path "apis"</dev:code> <dev:remarks><maml:para>This command imports an API from the specified WADL link. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/import-azurermapimanagementapi</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Export-AzureRmApiManagementApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-AzureRmApiManagementApi</command:name> <command:verb>New</command:verb> <command:noun>AzureRmApiManagementApi</command:noun> <maml:description><maml:para>Creates an API. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The New-AzureRmApiManagementApi cmdlet creates an Azure API Management API. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-AzureRmApiManagementApi</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies the ID of the API to create. If you do not specify this parameter, this cmdlet generates an ID for you. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AuthorizationScope</maml:name> <maml:Description><maml:para>Specifies the OAuth operations scope. The default value is $Null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AuthorizationServerId</maml:name> <maml:Description><maml:para>Specifies the OAuth authorization server ID. The default value is $Null. You must specify this parameter if AuthorizationScope is specified. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Specifies a description for the web API. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the web API. This is the public name of the API as it appears on the developer and admin portals. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Path</maml:name> <maml:Description><maml:para>Specifies the web API path, which is the last part of the API's public URL and corresponds to the Web API URL suffix field in the admin portal. This URL is used by API consumers to send requests to the web service, and must be one to 400 characters long. The default value is $Null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductIds</maml:name> <maml:Description><maml:para>Specifies an array of product IDs to which to add the new API. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Protocols</maml:name> <maml:Description><maml:para>Specifies an array of web API protocols. Valid values are http, https. These are the web protocols over which the API is made available. The default value is $Null. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Http</command:parameterValue> <command:parameterValue required="false" variableLength="false">Https</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PsApiManagementSchema[]</command:parameterValue> <dev:type><maml:name>PsApiManagementSchema[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ServiceUrl</maml:name> <maml:Description><maml:para>Specifies the URL of the web service that exposes the API. This URL is used only by Azure API Management, and is not made public. The URL must be one to 2000 characters long. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SubscriptionKeyHeaderName</maml:name> <maml:Description><maml:para>Specifies the subscription key header name. The default value is $Null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SubscriptionKeyQueryParamName</maml:name> <maml:Description><maml:para>Specifies the subscription key query string parameter name. The default value is $Null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies the ID of the API to create. If you do not specify this parameter, this cmdlet generates an ID for you. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AuthorizationScope</maml:name> <maml:Description><maml:para>Specifies the OAuth operations scope. The default value is $Null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AuthorizationServerId</maml:name> <maml:Description><maml:para>Specifies the OAuth authorization server ID. The default value is $Null. You must specify this parameter if AuthorizationScope is specified. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Specifies a description for the web API. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the web API. This is the public name of the API as it appears on the developer and admin portals. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Path</maml:name> <maml:Description><maml:para>Specifies the web API path, which is the last part of the API's public URL and corresponds to the Web API URL suffix field in the admin portal. This URL is used by API consumers to send requests to the web service, and must be one to 400 characters long. The default value is $Null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductIds</maml:name> <maml:Description><maml:para>Specifies an array of product IDs to which to add the new API. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Protocols</maml:name> <maml:Description><maml:para>Specifies an array of web API protocols. Valid values are http, https. These are the web protocols over which the API is made available. The default value is $Null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementSchema[]</command:parameterValue> <dev:type><maml:name>PsApiManagementSchema[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ServiceUrl</maml:name> <maml:Description><maml:para>Specifies the URL of the web service that exposes the API. This URL is used only by Azure API Management, and is not made public. The URL must be one to 2000 characters long. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SubscriptionKeyHeaderName</maml:name> <maml:Description><maml:para>Specifies the subscription key header name. The default value is $Null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SubscriptionKeyQueryParamName</maml:name> <maml:Description><maml:para>Specifies the subscription key query string parameter name. The default value is $Null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Create an API</maml:title> <dev:code>PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>New-AzureRmApiManagementApi -Context $ApiMgmtContext -Name "Echo api" -ServiceUrl "https://contoso.com/apis/echo" -Protocols @("http", "https") -Path "testapi"</dev:code> <dev:remarks><maml:para>This command creates an API named EchoApi with the specified URL. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementapi</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Export-AzureRmApiManagementApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Import-AzureRmApiManagementApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-AzureRmApiManagementAuthorizationServer</command:name> <command:verb>New</command:verb> <command:noun>AzureRmApiManagementAuthorizationServer</command:noun> <maml:description><maml:para>Creates an authorization server. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The New-AzureRmApiManagementAuthorizationServer cmdlet creates an Azure API Management authorization server. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-AzureRmApiManagementAuthorizationServer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AccessTokenSendingMethods</maml:name> <maml:Description><maml:para>Specifies an array of methods to send an access token. psdx_paramvalues AuthorizationHeader and Query. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">AuthorizationHeader</command:parameterValue> <command:parameterValue required="false" variableLength="false">Query</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PsApiManagementAccessTokenSendingMethod[]</command:parameterValue> <dev:type><maml:name>PsApiManagementAccessTokenSendingMethod[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AuthorizationEndpointUrl</maml:name> <maml:Description><maml:para>Specifies the authorization endpoint to authenticate resource owners and obtain authorization grants. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AuthorizationRequestMethods</maml:name> <maml:Description><maml:para>Specifies an array of authorization request methods. Valid values are: GET, POST. The default value is GET. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Get</command:parameterValue> <command:parameterValue required="false" variableLength="false">Post</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PsApiManagementAuthorizationRequestMethod[]</command:parameterValue> <dev:type><maml:name>PsApiManagementAuthorizationRequestMethod[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientAuthenticationMethods</maml:name> <maml:Description><maml:para>Specifies an array of client authentication methods. psdx_paramvalues Basic and Body. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Basic</command:parameterValue> <command:parameterValue required="false" variableLength="false">Body</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PsApiManagementClientAuthenticationMethod[]</command:parameterValue> <dev:type><maml:name>PsApiManagementClientAuthenticationMethod[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientId</maml:name> <maml:Description><maml:para>Specifies the client ID of the developer console that is the client application. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientRegistrationPageUrl</maml:name> <maml:Description><maml:para>Specifies the client registration endpoint to register clients with the authorization server and obtain client credentials. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientSecret</maml:name> <maml:Description><maml:para>Specifies the client secret of developer console that is the client application. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>DefaultScope</maml:name> <maml:Description><maml:para>Specifies the default scope for the authorization server. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Specifies a description for an authorization server. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>GrantTypes</maml:name> <maml:Description><maml:para>Specifies an array of grant types. psdx_paramvalues </maml:para> <maml:para>- AuthorizationCode </maml:para> <maml:para>- ClientCredentials </maml:para> <maml:para>- Implicit </maml:para> <maml:para>- ResourceOwnerPassword </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">AuthorizationCode</command:parameterValue> <command:parameterValue required="false" variableLength="false">Implicit</command:parameterValue> <command:parameterValue required="false" variableLength="false">ResourceOwnerPassword</command:parameterValue> <command:parameterValue required="false" variableLength="false">ClientCredentials</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PsApiManagementGrantType[]</command:parameterValue> <dev:type><maml:name>PsApiManagementGrantType[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the authorization server to create. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ResourceOwnerPassword</maml:name> <maml:Description><maml:para>Specifies the resource owner password. You must specify this parameter is required if ResourceOwnerPassword is specified by the GrantTypes parameter. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ResourceOwnerUsername</maml:name> <maml:Description><maml:para>Specifies the resource owner user name. You must specify this parameter if ResourceOwnerPassword is specified by the GrantTypes parameter. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ServerId</maml:name> <maml:Description><maml:para>Specifies the ID of the authorization server to create. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SupportState</maml:name> <maml:Description><maml:para>Indicates whether to support the State parameter. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type><maml:name>Boolean</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>TokenBodyParameters</maml:name> <maml:Description><maml:para>Specifies additional body parameters using application/x-www-form-urlencoded format. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>TokenEndpointUrl</maml:name> <maml:Description><maml:para>Specifies the token endpoint URL that is used by clients to obtain access tokens in exchange for presenting authorization grants or refresh tokens. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AccessTokenSendingMethods</maml:name> <maml:Description><maml:para>Specifies an array of methods to send an access token. psdx_paramvalues AuthorizationHeader and Query. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementAccessTokenSendingMethod[]</command:parameterValue> <dev:type><maml:name>PsApiManagementAccessTokenSendingMethod[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AuthorizationEndpointUrl</maml:name> <maml:Description><maml:para>Specifies the authorization endpoint to authenticate resource owners and obtain authorization grants. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AuthorizationRequestMethods</maml:name> <maml:Description><maml:para>Specifies an array of authorization request methods. Valid values are: GET, POST. The default value is GET. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementAuthorizationRequestMethod[]</command:parameterValue> <dev:type><maml:name>PsApiManagementAuthorizationRequestMethod[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientAuthenticationMethods</maml:name> <maml:Description><maml:para>Specifies an array of client authentication methods. psdx_paramvalues Basic and Body. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementClientAuthenticationMethod[]</command:parameterValue> <dev:type><maml:name>PsApiManagementClientAuthenticationMethod[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientId</maml:name> <maml:Description><maml:para>Specifies the client ID of the developer console that is the client application. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientRegistrationPageUrl</maml:name> <maml:Description><maml:para>Specifies the client registration endpoint to register clients with the authorization server and obtain client credentials. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientSecret</maml:name> <maml:Description><maml:para>Specifies the client secret of developer console that is the client application. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>DefaultScope</maml:name> <maml:Description><maml:para>Specifies the default scope for the authorization server. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Specifies a description for an authorization server. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>GrantTypes</maml:name> <maml:Description><maml:para>Specifies an array of grant types. psdx_paramvalues </maml:para> <maml:para>- AuthorizationCode </maml:para> <maml:para>- ClientCredentials </maml:para> <maml:para>- Implicit </maml:para> <maml:para>- ResourceOwnerPassword </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementGrantType[]</command:parameterValue> <dev:type><maml:name>PsApiManagementGrantType[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the authorization server to create. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ResourceOwnerPassword</maml:name> <maml:Description><maml:para>Specifies the resource owner password. You must specify this parameter is required if ResourceOwnerPassword is specified by the GrantTypes parameter. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ResourceOwnerUsername</maml:name> <maml:Description><maml:para>Specifies the resource owner user name. You must specify this parameter if ResourceOwnerPassword is specified by the GrantTypes parameter. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ServerId</maml:name> <maml:Description><maml:para>Specifies the ID of the authorization server to create. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SupportState</maml:name> <maml:Description><maml:para>Indicates whether to support the State parameter. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type><maml:name>Boolean</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>TokenBodyParameters</maml:name> <maml:Description><maml:para>Specifies additional body parameters using application/x-www-form-urlencoded format. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>TokenEndpointUrl</maml:name> <maml:Description><maml:para>Specifies the token endpoint URL that is used by clients to obtain access tokens in exchange for presenting authorization grants or refresh tokens. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOAuth2AuthrozationServer</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Create an authorization server</maml:title> <dev:code>PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>New-AzureRmApiManagementAuthrizarionServer -Context $ApiMgmtContext -Name "Contoso OAuth2 server" -ClientRegistrationPageUrl "https://contoso/signup" -AuthorizationEndpointUrl "https://contoso/auth" -TokenEndpointUrl "https://contoso/token" -ClientId "clientid" -ClientSecret "e041ed1b660b4eadbad5a29d066e6e88" -AuthorizationRequestMethods @('Get', 'Post') -GrantTypes @( 'AuthorizationCode', 'Implicit', 'ResourceOwnerPassword', 'ClientCredentials') -ClientAuthenticationMethods @('Basic') -TokenBodyParameters @{'par1'='val1'; 'par2'='val2'} -AccessTokenSendingMethods @('AuthorizationHeader', 'Query') -ResourceOwnerUsername "ivan" -ResourceOwnerPassword "qwerty"</dev:code> <dev:remarks><maml:para>This command creates an authorization server. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementauthorizationserver</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-AzureRmApiManagementBackend</command:name> <command:verb>New</command:verb> <command:noun>AzureRmApiManagementBackend</command:noun> <maml:description><maml:para>Creates a new backend entity. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Creates a new backend entity in Api Management. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-AzureRmApiManagementBackend</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>BackendId</maml:name> <maml:Description><maml:para>Identifier of new backend. This parameter is optional. If not specified will be generated. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Instance of PsApiManagementContext. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Credential details which should be used when talking to the Backend. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementBackendCredential</command:parameterValue> <dev:type><maml:name>PsApiManagementBackendCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Backend Description. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Protocol</maml:name> <maml:Description><maml:para>Backend Communication protocol. This parameter is required. Valid values are 'http' and 'soap'. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">http</command:parameterValue> <command:parameterValue required="false" variableLength="false">soap</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Proxy</maml:name> <maml:Description><maml:para>Proxy Server details to be used while sending request to the Backend. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementBackendProxy</command:parameterValue> <dev:type><maml:name>PsApiManagementBackendProxy</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ResourceId</maml:name> <maml:Description><maml:para>Management Uri of the Resource in External System. This parameter is optional. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SkipCertificateChainValidation</maml:name> <maml:Description><maml:para>Whether to Skip Certificate Chain Validation when talking to the Backend. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type><maml:name>Boolean</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SkipCertificateNameValidation</maml:name> <maml:Description><maml:para>Whether to skip Certificate Name Validation when talking to the Backend. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type><maml:name>Boolean</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Title</maml:name> <maml:Description><maml:para>Backend Title. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Url</maml:name> <maml:Description><maml:para>Runtime Url for the Backend. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>BackendId</maml:name> <maml:Description><maml:para>Identifier of new backend. This parameter is optional. If not specified will be generated. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Instance of PsApiManagementContext. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Credential details which should be used when talking to the Backend. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementBackendCredential</command:parameterValue> <dev:type><maml:name>PsApiManagementBackendCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Backend Description. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Protocol</maml:name> <maml:Description><maml:para>Backend Communication protocol. This parameter is required. Valid values are 'http' and 'soap'. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Proxy</maml:name> <maml:Description><maml:para>Proxy Server details to be used while sending request to the Backend. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementBackendProxy</command:parameterValue> <dev:type><maml:name>PsApiManagementBackendProxy</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ResourceId</maml:name> <maml:Description><maml:para>Management Uri of the Resource in External System. This parameter is optional. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SkipCertificateChainValidation</maml:name> <maml:Description><maml:para>Whether to Skip Certificate Chain Validation when talking to the Backend. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type><maml:name>Boolean</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SkipCertificateNameValidation</maml:name> <maml:Description><maml:para>Whether to skip Certificate Name Validation when talking to the Backend. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type><maml:name>Boolean</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Title</maml:name> <maml:Description><maml:para>Backend Title. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Url</maml:name> <maml:Description><maml:para>Runtime Url for the Backend. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackend</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Create Backend 123 with a Basic Authorization Scheme</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>$credential = New-AzureRmApiManagementBackendCredential -AuthorizationHeaderScheme basic -AuthorizationHeaderParameter opensesame -Query @{"sv" = @('xx', 'bb'); "sr" = @('cc')} -Header @{"x-my-1" = @('val1', 'val2')} PS C:\>$backend = New-AzureRmApiManagementBackend -Context $apimContext -BackendId 123 -Url 'https://contoso.com/awesomeapi' -Protocol http -Title "first backend" -SkipCertificateChainValidation $true -Credential $credential -Description "my backend"</dev:code> <dev:remarks><maml:para>Creates a new Backend </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementbackend</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementBackend</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementBackendCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementBackendProxy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementBackend</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementBackend</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-AzureRmApiManagementBackendCredential</command:name> <command:verb>New</command:verb> <command:noun>AzureRmApiManagementBackendCredential</command:noun> <maml:description><maml:para>Creates a new Backend Credential contract. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Creates a new Backend Credential contract. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-AzureRmApiManagementBackendCredential</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AuthorizationHeaderParameter</maml:name> <maml:Description><maml:para>Authorization Header used for the Backend. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AuthorizationHeaderScheme</maml:name> <maml:Description><maml:para>Authorization Scheme used for the Backend. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>CertificateThumbprint</maml:name> <maml:Description><maml:para>Client Certificate Thumbprints. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Header</maml:name> <maml:Description><maml:para>Header Parameter Values accepted by Backend. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Query</maml:name> <maml:Description><maml:para>Query Parameter Values accepted by Backend. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AuthorizationHeaderParameter</maml:name> <maml:Description><maml:para>Authorization Header used for the Backend. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>AuthorizationHeaderScheme</maml:name> <maml:Description><maml:para>Authorization Scheme used for the Backend. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>CertificateThumbprint</maml:name> <maml:Description><maml:para>Client Certificate Thumbprints. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Header</maml:name> <maml:Description><maml:para>Header Parameter Values accepted by Backend. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Query</maml:name> <maml:Description><maml:para>Query Parameter Values accepted by Backend. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackendCredential</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Create a Backend Credentials In-Memory Object</maml:title> <dev:code>PS C:\>$credential = New-AzureRmApiManagementBackendCredential -AuthorizationHeaderScheme basic -AuthorizationHeaderParameter opensesame -Query @{"sv" = @('xx', 'bb'); "sr" = @('cc')} -Header @{"x-my-1" = @('val1', 'val2')}</dev:code> <dev:remarks><maml:para>Creates a Backend Credentials Contract </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementbackendcredential</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementBackend</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementBackend</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementBackendProxy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementBackend</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementBackend</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-AzureRmApiManagementBackendProxy</command:name> <command:verb>New</command:verb> <command:noun>AzureRmApiManagementBackendProxy</command:noun> <maml:description><maml:para>Creates a new Backend Proxy Object. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Creates a new Backend Proxy Object which can be piped when creating a new Backend entity. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-AzureRmApiManagementBackendProxy</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ProxyCredential</maml:name> <maml:Description><maml:para>Credentials used to connect to Backend Proxy. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Url</maml:name> <maml:Description><maml:para>Url of the Proxy server to be used when forwarding calls to Backend. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ProxyCredential</maml:name> <maml:Description><maml:para>Credentials used to connect to Backend Proxy. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSCredential</command:parameterValue> <dev:type><maml:name>PSCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Url</maml:name> <maml:Description><maml:para>Url of the Proxy server to be used when forwarding calls to Backend. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackendProxy</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Create a Backend Proxy In-Memory Object</maml:title> <dev:code>PS C:\>$secpassword = ConvertTo-SecureString "PlainTextPassword" -AsPlainText -Force PS C:\>$proxyCreds = New-Object System.Management.Automation.PSCredential ("foo", $secpassword) PS C:\>$credential = New-AzureRmApiManagementBackendProxy -Url "http://12.168.1.1:8080" -ProxyCredential $proxyCreds</dev:code> <dev:remarks><maml:para>Creates a Backend Proxy Object </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementbackendproxy</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementBackend</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementBackend</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementBackendCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementBackend</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementBackend</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-AzureRmApiManagementCertificate</command:name> <command:verb>New</command:verb> <command:noun>AzureRmApiManagementCertificate</command:noun> <maml:description><maml:para>Creates an API Management certificate to be used during Authentication with Backend. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The New-AzureRmApiManagementCertificate cmdlet creates an Azure API Management certificate. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-AzureRmApiManagementCertificate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>CertificateId</maml:name> <maml:Description><maml:para>Specifies the ID of the certificate to create. If you do not specify this parameter, an ID is generated for you. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PfxBytes</maml:name> <maml:Description><maml:para>Specifies an array of bytes of the certificate file in .pfx format. This parameter is required if you do not specify the PfxFilePath parameter. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Byte[]</command:parameterValue> <dev:type><maml:name>Byte[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PfxPassword</maml:name> <maml:Description><maml:para>Specifies the password for the certificate. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>New-AzureRmApiManagementCertificate</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>CertificateId</maml:name> <maml:Description><maml:para>Specifies the ID of the certificate to create. If you do not specify this parameter, an ID is generated for you. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PfxFilePath</maml:name> <maml:Description><maml:para>Specifies the path to the certificate file in .pfx format to create and upload. This parameter is required if you do not specify the PfxBytes parameter. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PfxPassword</maml:name> <maml:Description><maml:para>Specifies the password for the certificate. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>CertificateId</maml:name> <maml:Description><maml:para>Specifies the ID of the certificate to create. If you do not specify this parameter, an ID is generated for you. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PfxBytes</maml:name> <maml:Description><maml:para>Specifies an array of bytes of the certificate file in .pfx format. This parameter is required if you do not specify the PfxFilePath parameter. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Byte[]</command:parameterValue> <dev:type><maml:name>Byte[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PfxFilePath</maml:name> <maml:Description><maml:para>Specifies the path to the certificate file in .pfx format to create and upload. This parameter is required if you do not specify the PfxBytes parameter. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PfxPassword</maml:name> <maml:Description><maml:para>Specifies the password for the certificate. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementCertificate</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Create and upload a certificate</maml:title> <dev:code>PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>New-AzureRmApiManagementCertificate -Context $ApiMgmtContext -PfxFilePath "C:\contoso\certificates\apimanagement.pfx" -PfxPassword "1111"</dev:code> <dev:remarks><maml:para>This command uploads a certificate to Api Management. This certificate can be used for mutual authentication with backend using policies. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementcertificate</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-AzureRmApiManagementContext</command:name> <command:verb>New</command:verb> <command:noun>AzureRmApiManagementContext</command:noun> <maml:description><maml:para>Creates an instance of PsAzureApiManagementContext. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The New-AzureRmApiManagementContext cmdlet creates an instance of PsAzureApiManagementContext . The context is used for all of the API Management service cmdlets. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-AzureRmApiManagementContext</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group under which an API Management service is deployed. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ServiceName</maml:name> <maml:Description><maml:para>Specifies the name of the deployed API Management service. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ResourceGroupName</maml:name> <maml:Description><maml:para>Specifies the name of the resource group under which an API Management service is deployed. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ServiceName</maml:name> <maml:Description><maml:para>Specifies the name of the deployed API Management service. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsAzureApiManagementContext</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Create a PsApiManagementContext instance</maml:title> <dev:code>PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "ContosoResources" -ServiceName "Contoso"</dev:code> <dev:remarks><maml:para>This command creates an instance of PsApiManagementContext . </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementcontext</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-AzureRmApiManagementGroup</command:name> <command:verb>New</command:verb> <command:noun>AzureRmApiManagementGroup</command:noun> <maml:description><maml:para>Creates an API management group. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The New-AzureRmApiManagementGroup cmdlet creates an API management group. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-AzureRmApiManagementGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies the instance of the PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Specifies the description of the management group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ExternalId</maml:name> <maml:Description><maml:para>For external groups, this property contains the id of the group from the external identity provider, e.g. Azure Active Directory aad://contoso5api.onmicrosoft.com/groups/12ad42b1-592f-4664-a77b4250-2f2e82579f4c; otherwise the value is null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>GroupId</maml:name> <maml:Description><maml:para>Specifies the identifier of the new management group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the management group name. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Type</maml:name> <maml:Description><maml:para>Group Type. Custom Group is User defined Group. System Group includes Administrator, Developers and Guests. You cannot create or update a System Group. External Group is groups from External Identity Provider like Azure Active Directory. This parameter is optional and by default assumed to be a Custom Group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementGroupType</command:parameterValue> <dev:type><maml:name>PsApiManagementGroupType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies the instance of the PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Specifies the description of the management group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>ExternalId</maml:name> <maml:Description><maml:para>For external groups, this property contains the id of the group from the external identity provider, e.g. Azure Active Directory aad://contoso5api.onmicrosoft.com/groups/12ad42b1-592f-4664-a77b4250-2f2e82579f4c; otherwise the value is null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>GroupId</maml:name> <maml:Description><maml:para>Specifies the identifier of the new management group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the management group name. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Type</maml:name> <maml:Description><maml:para>Group Type. Custom Group is User defined Group. System Group includes Administrator, Developers and Guests. You cannot create or update a System Group. External Group is groups from External Identity Provider like Azure Active Directory. This parameter is optional and by default assumed to be a Custom Group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementGroupType</command:parameterValue> <dev:type><maml:name>PsApiManagementGroupType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGroup</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Create a management group</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>New-AzureRmApiManagementGroup -Context $apimContext -Name "Group0001"</dev:code> <dev:remarks><maml:para>This command creates a management group. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementgroup</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-AzureRmApiManagementIdentityProvider</command:name> <command:verb>New</command:verb> <command:noun>AzureRmApiManagementIdentityProvider</command:noun> <maml:description><maml:para>Creates a new Identity Provider configuration. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Creates a new Identity Provider configuration. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-AzureRmApiManagementIdentityProvider</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AllowedTenants</maml:name> <maml:Description><maml:para>List of allowed Azure Active Directory Tenants </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientId</maml:name> <maml:Description><maml:para>Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientSecret</maml:name> <maml:Description><maml:para>Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Instance of PsApiManagementContext. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Type</maml:name> <maml:Description><maml:para>Identifier of a Identity Provider. If specified will try to find identity provider configuration by the identifier. This parameter is optional. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Facebook</command:parameterValue> <command:parameterValue required="false" variableLength="false">Google</command:parameterValue> <command:parameterValue required="false" variableLength="false">Microsoft</command:parameterValue> <command:parameterValue required="false" variableLength="false">Twitter</command:parameterValue> <command:parameterValue required="false" variableLength="false">Aad</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PsApiManagementIdentityProviderType</command:parameterValue> <dev:type><maml:name>PsApiManagementIdentityProviderType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AllowedTenants</maml:name> <maml:Description><maml:para>List of allowed Azure Active Directory Tenants </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientId</maml:name> <maml:Description><maml:para>Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientSecret</maml:name> <maml:Description><maml:para>Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Instance of PsApiManagementContext. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Type</maml:name> <maml:Description><maml:para>Identifier of a Identity Provider. If specified will try to find identity provider configuration by the identifier. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementIdentityProviderType</command:parameterValue> <dev:type><maml:name>PsApiManagementIdentityProviderType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProvider</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Configures Facebook as an identity Provider for Developer Portal Logins</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>New-AzureRmApiManagementIdentityProvider -Context $apimContext -Type 'Facebook' -ClientId 'sdfsfwerwerw' -ClientSecret 'sdgsdfgfst43tewfewrf'</dev:code> <dev:remarks><maml:para>This command configures Facebook Identity as a accepted Identity Provider on the Developer Portal of the ApiManagement service. This takes as input the ClientId and ClientSecret of the Facebook app. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementidentityprovider</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementIdentityProvider</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementIdentityProvider</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementIdentityProvider</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-AzureRmApiManagementLogger</command:name> <command:verb>New</command:verb> <command:noun>AzureRmApiManagementLogger</command:noun> <maml:description><maml:para>Creates an API Management Logger. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The New-AzureRmApiManagementLogger cmdlet creates an Azure API Management Logger . </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-AzureRmApiManagementLogger</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ConnectionString</maml:name> <maml:Description><maml:para>Specifies an Azure Event Hubs connection string that starts with the following: </maml:para> <maml:para>`Endpoint=endpoint and key from Azure classic portal` </maml:para> <maml:para>The Key with Send Rights in the connection string must be configured. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Specifies a description. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>IsBuffered</maml:name> <maml:Description><maml:para>Specifies whether the records in the logger are buffered before publishing. The default value is $True. When records are buffered, they are sent to Event Hubs every 15 seconds, or whenever the buffer receives 256 KB of messages. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type><maml:name>Boolean</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>LoggerId</maml:name> <maml:Description><maml:para>Specifies an ID for the logger. If you do not specify an ID, this cmdlet generates one. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the entity name of an event hub from Azure classic portal. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ConnectionString</maml:name> <maml:Description><maml:para>Specifies an Azure Event Hubs connection string that starts with the following: </maml:para> <maml:para>`Endpoint=endpoint and key from Azure classic portal` </maml:para> <maml:para>The Key with Send Rights in the connection string must be configured. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Specifies a description. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>IsBuffered</maml:name> <maml:Description><maml:para>Specifies whether the records in the logger are buffered before publishing. The default value is $True. When records are buffered, they are sent to Event Hubs every 15 seconds, or whenever the buffer receives 256 KB of messages. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type><maml:name>Boolean</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>LoggerId</maml:name> <maml:Description><maml:para>Specifies an ID for the logger. If you do not specify an ID, this cmdlet generates one. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the entity name of an event hub from Azure classic portal. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementLogger</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Create a logger</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>New-AzureRmApiManagementLogger -Context $apimContext -LoggerId "Logger123" -Name "ContosoSdkEventHub" -ConnectionString "Endpoint=sb://ContosoSdkEventHubs.servicebus.windows.net/;SharedAccessKeyName=SendKey;SharedAccessKey=<key>" -Description "SDK event hub logger"</dev:code> <dev:remarks><maml:para>This command creates a logger named ContosoSdkEventHub by using the specified connection string. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementlogger</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementLogger</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementLogger</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementLogger</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-AzureRmApiManagementOpenIdConnectProvider</command:name> <command:verb>New</command:verb> <command:noun>AzureRmApiManagementOpenIdConnectProvider</command:noun> <maml:description><maml:para>Creates an OpenID Connect provider. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The New-AzureRmApiManagementOpenIdConnectProvider cmdlet creates an OpenID Connect provider in Azure API Management. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-AzureRmApiManagementOpenIdConnectProvider</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientId</maml:name> <maml:Description><maml:para>Specifies the client ID of the developer console. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientSecret</maml:name> <maml:Description><maml:para>Specifies the client secret of the developer console. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Specifies a description. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>MetadataEndpointUri</maml:name> <maml:Description><maml:para>Specifies a metadata endpoint URI of the provider. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies a friendly name for the provider. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OpenIdConnectProviderId</maml:name> <maml:Description><maml:para>Specifies an ID for the provider. If you do not specify an ID, this cmdlet generates one. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientId</maml:name> <maml:Description><maml:para>Specifies the client ID of the developer console. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientSecret</maml:name> <maml:Description><maml:para>Specifies the client secret of the developer console. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Specifies a description. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>MetadataEndpointUri</maml:name> <maml:Description><maml:para>Specifies a metadata endpoint URI of the provider. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies a friendly name for the provider. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OpenIdConnectProviderId</maml:name> <maml:Description><maml:para>Specifies an ID for the provider. If you do not specify an ID, this cmdlet generates one. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOpenIdConnectProvider</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Create a provider</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>New-AzureRmApiManagementOpenIdConnectProvider -Context $apimContext -OpenIdConnectProviderId "OICProvicer01" -Name "Contoso OpenID Connect Provider" -MetadataEndpointUri "https://openid.provider/configuration" -ClientId "12432143" -Description "OpenID Connect provider description"</dev:code> <dev:remarks><maml:para>This command creates an OpenID Connect Provider named Contoso OpenID Connect Provider </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementopenidconnectprovider</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementOpenIdConnectProvider</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementOpenIdConnectProvider</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementOpenIdConnectProvider</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-AzureRmApiManagementOperation</command:name> <command:verb>New</command:verb> <command:noun>AzureRmApiManagementOperation</command:noun> <maml:description><maml:para>Creates an API management operation. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The New-AzureRmApiManagementOperation cmdlet create an API operation. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-AzureRmApiManagementOperation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies the identifier of the API management operation. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies the instance of the PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Specifies the description of new API operation. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Method</maml:name> <maml:Description><maml:para>Specifies the HTTP method of the new API management operation. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the display name of new API management operation. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OperationId</maml:name> <maml:Description><maml:para>Specifies the identifier of the API management operation. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Request</maml:name> <maml:Description><maml:para>Specifies the details of the API management operation. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementRequest</command:parameterValue> <dev:type><maml:name>PsApiManagementRequest</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Responses</maml:name> <maml:Description><maml:para>Specifies an array of possible API management operation responses. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementResponse[]</command:parameterValue> <dev:type><maml:name>PsApiManagementResponse[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>TemplateParameters</maml:name> <maml:Description><maml:para>Specifies an array of parameters defined in parameter UrlTemplate . If you do not specify this parameter, a default value will be generated based on the UrlTemplate . </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementParameter[]</command:parameterValue> <dev:type><maml:name>PsApiManagementParameter[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>UrlTemplate</maml:name> <maml:Description><maml:para>Specifies the URL template. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies the identifier of the API management operation. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies the instance of the PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Specifies the description of new API operation. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Method</maml:name> <maml:Description><maml:para>Specifies the HTTP method of the new API management operation. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the display name of new API management operation. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OperationId</maml:name> <maml:Description><maml:para>Specifies the identifier of the API management operation. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Request</maml:name> <maml:Description><maml:para>Specifies the details of the API management operation. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementRequest</command:parameterValue> <dev:type><maml:name>PsApiManagementRequest</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Responses</maml:name> <maml:Description><maml:para>Specifies an array of possible API management operation responses. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementResponse[]</command:parameterValue> <dev:type><maml:name>PsApiManagementResponse[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>TemplateParameters</maml:name> <maml:Description><maml:para>Specifies an array of parameters defined in parameter UrlTemplate . If you do not specify this parameter, a default value will be generated based on the UrlTemplate . </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementParameter[]</command:parameterValue> <dev:type><maml:name>PsApiManagementParameter[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>UrlTemplate</maml:name> <maml:Description><maml:para>Specifies the URL template. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOperation</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Create an API management operation</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>New-AzureRmApiManagementOperation -Context $apimContext -ApiId $APIId -OperationId "Operation001" -Name "Operation" -Method "GET" -UrlTemplate "/resource" -Description "Use this operation to get resource"</dev:code> <dev:remarks><maml:para>This command creates an API management operation. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Create an API management operation with request and response details</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>$RID = New-Object -TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementParameter $RID.Name = "RID" $RID.Description = "Resource identifier" $RID.Type = "string" $Query = New-Object -TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementParameter $Query.Name = "query" $Query.Description = "Query string" $Query.Type = 'string' $Request = New-Object -TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementRequest $Request.Description = "Create/update resource request" $DummyQp = New-Object -TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementParameter $DummyQp.Name = 'dummy' $DummyQp.Type = 'string' $DummyQp.Required = $FALSE $Request.QueryParameters = @($DummyQp) $Header = New-Object -TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementParameter $Header.Name = 'x-custom-header' $Header.Type = 'string' $Request.Headers = @($Header) $RequestRepresentation = New-Object -TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementRepresentation $RequestRepresentation.ContentType = 'application/json' $RequestRepresentation.Sample = '{ "propName": "propValue" }' $Request.Representations = @($requestRepresentation) $Response = New-Object -TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementResponse $Response.StatusCode = 204 PS C:\>New-AzureRmApiManagementOperation -Context $apimContext -ApiId $APIId -OperationId "01234567890" -Name 'Create/update resource' -Method 'PUT' -UrlTemplate '/resource/{rid}?q={query}' -Description "Use this operation to create new or update existing resource" -TemplateParameters @($rid, $query) -Request $Request -Responses @($response)</dev:code> <dev:remarks><maml:para>This example creates an API management operation with request and response details. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementoperation</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementOperation</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementOperation</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementOperation</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-AzureRmApiManagementProduct</command:name> <command:verb>New</command:verb> <command:noun>AzureRmApiManagementProduct</command:noun> <maml:description><maml:para>Creates an API Management product. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The New-AzureRmApiManagementProduct cmdlet creates an API Management product. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-AzureRmApiManagementProduct</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApprovalRequired</maml:name> <maml:Description><maml:para>Indicates whether the subscription to the product requires approval or not. By default, this parameter is $False . </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type><maml:name>Boolean</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies an instance of a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Specifies the product description. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>LegalTerms</maml:name> <maml:Description><maml:para>Specifies the legal terms of use of the product. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductId</maml:name> <maml:Description><maml:para>Specifies the identifier of new product. If you do not specify this parameter, a new product is generated. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>State</maml:name> <maml:Description><maml:para>Specifies the product state. psdx_paramvalues </maml:para> <maml:para>- NotPublished </maml:para> <maml:para>- Published </maml:para> <maml:para> </maml:para> <maml:para>The default value is NotPublished. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">NotPublished</command:parameterValue> <command:parameterValue required="false" variableLength="false">Published</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PsApiManagementProductState</command:parameterValue> <dev:type><maml:name>PsApiManagementProductState</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SubscriptionRequired</maml:name> <maml:Description><maml:para>Indicates whether the product requires a subscription. The default value is $True . </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type><maml:name>Boolean</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SubscriptionsLimit</maml:name> <maml:Description><maml:para>Specifies the maximum number of simultaneous subscriptions. The default value is 1. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Title</maml:name> <maml:Description><maml:para>Specifies the product title. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApprovalRequired</maml:name> <maml:Description><maml:para>Indicates whether the subscription to the product requires approval or not. By default, this parameter is $False . </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type><maml:name>Boolean</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies an instance of a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Specifies the product description. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>LegalTerms</maml:name> <maml:Description><maml:para>Specifies the legal terms of use of the product. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductId</maml:name> <maml:Description><maml:para>Specifies the identifier of new product. If you do not specify this parameter, a new product is generated. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>State</maml:name> <maml:Description><maml:para>Specifies the product state. psdx_paramvalues </maml:para> <maml:para>- NotPublished </maml:para> <maml:para>- Published </maml:para> <maml:para> </maml:para> <maml:para>The default value is NotPublished. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementProductState</command:parameterValue> <dev:type><maml:name>PsApiManagementProductState</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SubscriptionRequired</maml:name> <maml:Description><maml:para>Indicates whether the product requires a subscription. The default value is $True . </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type><maml:name>Boolean</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SubscriptionsLimit</maml:name> <maml:Description><maml:para>Specifies the maximum number of simultaneous subscriptions. The default value is 1. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Title</maml:name> <maml:Description><maml:para>Specifies the product title. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProduct</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Create a product that does not require a subscription</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>New-AzureRmApiManagementProduct -Context $apimContext -ProductId "0123456789" -Title "Starter" -Description "Starter Product" -LegalTerms "Free for all" -SubscriptionRequired $False -State "Published"</dev:code> <dev:remarks><maml:para>This command creates an API Management product. No subscription is required. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Create a product that requires a subscription and approval</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>New-AzureRmApiManagementProduct -Context $apimContext -ProductId "9876543210" -Title "Unlimited" -Description "Subscribers have completely unlimited access to the API. Administrator approval is required." -LegalTerms "Free for all" -ApprovalRequired $True -State "Published" -NotificationPeriod "D10" -SubscriptionPeriod "Y1"</dev:code> <dev:remarks><maml:para>This command creates a product. A subscription and approval are required. This command sets the notification period to 10 days. The subscription duration is set to one year. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementproduct</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementProduct</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementProduct</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementProduct</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-AzureRmApiManagementProperty</command:name> <command:verb>New</command:verb> <command:noun>AzureRmApiManagementProperty</command:noun> <maml:description><maml:para>Creates a new Property. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The New-AzureRmApiManagementProperty cmdlet creates an Azure API Management Property . </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-AzureRmApiManagementProperty</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the property that this cmdlet creates. Maximum length is 100 characters. Names contain only letters, digits, period, dash, and underscore characters. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PropertyId</maml:name> <maml:Description><maml:para>Specifies an ID for the property. Maximum length is 256 characters. If you do not specify an ID, this cmdlet generates one. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Secret</maml:name> <maml:Description><maml:para>Indicates that the property value is a secret and should be encrypted. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Tags"><maml:name>Tag</maml:name> <maml:Description><maml:para>Tags to be associated with Property. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Value</maml:name> <maml:Description><maml:para>Specifies a value for the property. This value can contain policy expressions. Maximum length is 1000 characters. The value may not be empty or consist only of whitespace. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the property that this cmdlet creates. Maximum length is 100 characters. Names contain only letters, digits, period, dash, and underscore characters. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PropertyId</maml:name> <maml:Description><maml:para>Specifies an ID for the property. Maximum length is 256 characters. If you do not specify an ID, this cmdlet generates one. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Secret</maml:name> <maml:Description><maml:para>Indicates that the property value is a secret and should be encrypted. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Tags"><maml:name>Tag</maml:name> <maml:Description><maml:para>Tags to be associated with Property. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Value</maml:name> <maml:Description><maml:para>Specifies a value for the property. This value can contain policy expressions. Maximum length is 1000 characters. The value may not be empty or consist only of whitespace. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProperty</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Create a property that includes tags</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>$Tags = 'sdk', 'powershell' PS C:\> New-AzureRmApiManagementProperty -Context $apimContext -PropertyId "Property11" -Name "Property Name" -Value "Property Value" -Tags $Tags</dev:code> <dev:remarks><maml:para>The first command assigns two values to the $Tags variable. </maml:para> <maml:para>The second command creates a property and assigns the strings in $Tags as tags on the property. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Create a property that has a secret value</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>New-AzureRmApiManagementProperty -Context $apimContext -PropertyId "Property12" -Name "Secret Property -Value "Secret Property Value" -Secret</dev:code> <dev:remarks><maml:para>This command creates a Property that has a value that is encrypted. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementproperty</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-AzureRmApiManagementSubscription</command:name> <command:verb>New</command:verb> <command:noun>AzureRmApiManagementSubscription</command:noun> <maml:description><maml:para>Creates a subscription. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The New-AzureRmApiManagementSubscription cmdlet creates a subscription. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-AzureRmApiManagementSubscription</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the subscription name. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PrimaryKey</maml:name> <maml:Description><maml:para>Specifies the subscription primary key. If this parameter is not specified the key is generated automatically. This parameter must be 1 to 300 characters long. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductId</maml:name> <maml:Description><maml:para>Specifies the ID of the product to which to subscribe. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SecondaryKey</maml:name> <maml:Description><maml:para>Specifies the subscription secondary key. This parameter is generated automatically if it is not specified. This parameter must be 1 to 300 characters long. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>State</maml:name> <maml:Description><maml:para>Specifies the subscription state. The default value is $Null. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Suspended</command:parameterValue> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Expired</command:parameterValue> <command:parameterValue required="false" variableLength="false">Submitted</command:parameterValue> <command:parameterValue required="false" variableLength="false">Rejected</command:parameterValue> <command:parameterValue required="false" variableLength="false">Cancelled</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PsApiManagementSubscriptionState</command:parameterValue> <dev:type><maml:name>PsApiManagementSubscriptionState</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SubscriptionId</maml:name> <maml:Description><maml:para>Specifies the subscription ID. This parameter is generated if not specified. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>UserId</maml:name> <maml:Description><maml:para>Specifies the subscriber ID. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the subscription name. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PrimaryKey</maml:name> <maml:Description><maml:para>Specifies the subscription primary key. If this parameter is not specified the key is generated automatically. This parameter must be 1 to 300 characters long. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductId</maml:name> <maml:Description><maml:para>Specifies the ID of the product to which to subscribe. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SecondaryKey</maml:name> <maml:Description><maml:para>Specifies the subscription secondary key. This parameter is generated automatically if it is not specified. This parameter must be 1 to 300 characters long. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>State</maml:name> <maml:Description><maml:para>Specifies the subscription state. The default value is $Null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementSubscriptionState</command:parameterValue> <dev:type><maml:name>PsApiManagementSubscriptionState</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SubscriptionId</maml:name> <maml:Description><maml:para>Specifies the subscription ID. This parameter is generated if not specified. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>UserId</maml:name> <maml:Description><maml:para>Specifies the subscriber ID. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscription</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Subscribe a user to a product</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>New-AzureRmApiManagementSubscription -Context $apimContext -UserId "777" -ProductId "999"</dev:code> <dev:remarks><maml:para>This command subscribes an existing user to a product. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementsubscription</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementSubscription</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementSubscription</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementSubscription</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>New-AzureRmApiManagementUser</command:name> <command:verb>New</command:verb> <command:noun>AzureRmApiManagementUser</command:noun> <maml:description><maml:para>Registers a new user. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The New-AzureRmApiManagementUser cmdlet registers a new user. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>New-AzureRmApiManagementUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Email</maml:name> <maml:Description><maml:para>Specifies the email address of the user. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>FirstName</maml:name> <maml:Description><maml:para>Specifies the first name of the user. This parameter must be 1 to 100 characters long. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>LastName</maml:name> <maml:Description><maml:para>Specifies the last name of the user. This parameter must be 1 to 100 characters long. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Note</maml:name> <maml:Description><maml:para>Specifies a note about the user. This parameter is optional. The default value is $Null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Password</maml:name> <maml:Description><maml:para>Specifies the user password. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type><maml:name>SecureString</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>State</maml:name> <maml:Description><maml:para>Specifies the user state. This parameter is optional. The default value of this parameter is $Null. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Blocked</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PsApiManagementUserState</command:parameterValue> <dev:type><maml:name>PsApiManagementUserState</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>UserId</maml:name> <maml:Description><maml:para>Specifies the user ID. This parameter is optional. If this parameter is not specified, this cmdlet generates a user ID. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Email</maml:name> <maml:Description><maml:para>Specifies the email address of the user. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>FirstName</maml:name> <maml:Description><maml:para>Specifies the first name of the user. This parameter must be 1 to 100 characters long. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>LastName</maml:name> <maml:Description><maml:para>Specifies the last name of the user. This parameter must be 1 to 100 characters long. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Note</maml:name> <maml:Description><maml:para>Specifies a note about the user. This parameter is optional. The default value is $Null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Password</maml:name> <maml:Description><maml:para>Specifies the user password. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type><maml:name>SecureString</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>State</maml:name> <maml:Description><maml:para>Specifies the user state. This parameter is optional. The default value of this parameter is $Null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementUserState</command:parameterValue> <dev:type><maml:name>PsApiManagementUserState</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>UserId</maml:name> <maml:Description><maml:para>Specifies the user ID. This parameter is optional. If this parameter is not specified, this cmdlet generates a user ID. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUser</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Register a new user</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>$securePassword = ConvertTo-SecureString "qwerty" -AsPlainText -Force PS C:\>New-AzureRmApiManagementUser -Context $apimContext -FirstName "Patti" -LastName "Fuller" -Email "Patti.Fuller@contoso.com" -Password $securePassword</dev:code> <dev:remarks><maml:para>This command registers a new user named Patti Fuller. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/new-azurermapimanagementuser</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Publish-AzureRmApiManagementTenantGitConfiguration</command:name> <command:verb>Publish</command:verb> <command:noun>AzureRmApiManagementTenantGitConfiguration</command:noun> <maml:description><maml:para>Publishes changes from a Git branch to the configuration database. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Publish-AzureRmApiManagementTenantGitConfiguration cmdlet publishes the changes from a Git branch to the configuration database. You can alternatively validate the changes in a Git branch without publishing. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Publish-AzureRmApiManagementTenantGitConfiguration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Branch</maml:name> <maml:Description><maml:para>Specifies the name of the Git branch from which this cmdlet deploys the configuration to the configuration database. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Indicates that this cmdlet deletes subscriptions to products that are deleted in this update. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a PsApiManagementOperationResult object. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ValidateOnly</maml:name> <maml:Description><maml:para>Indicates that this cmdlet validates the changes in the specified Git branch. It does not publish to the configuration database. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Branch</maml:name> <maml:Description><maml:para>Specifies the name of the Git branch from which this cmdlet deploys the configuration to the configuration database. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Indicates that this cmdlet deletes subscriptions to products that are deleted in this update. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a PsApiManagementOperationResult object. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ValidateOnly</maml:name> <maml:Description><maml:para>Indicates that this cmdlet validates the changes in the specified Git branch. It does not publish to the configuration database. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOperationResult</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Deploy Git changes</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Publish-AzureRmApiManagementTenantGitConfiguration -Context $apimContext -Branch 'master' -PassThru</dev:code> <dev:remarks><maml:para>This command publishes the changes from the specified branch to the configuration database. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Validate Git changes</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Publish-AzureRmApiManagementTenantGitConfiguration -Context $apimContext -Branch 'master' -ValidateOnly -PassThru</dev:code> <dev:remarks><maml:para>This command validates the changes in the Git branch against the configuration database. It does not publish changes. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/publish-azurermapimanagementtenantgitconfiguration</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Save-AzureRmApiManagementTenantGitConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Remove-AzureRmApiManagementApi</command:name> <command:verb>Remove</command:verb> <command:noun>AzureRmApiManagementApi</command:noun> <maml:description><maml:para>Removes an API. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Remove-AzureRmAzureRmApiManagementApi cmdlet removes an existing API. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Remove-AzureRmApiManagementApi</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies the ID of the API remove. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies the ID of the API remove. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Boolean</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Remove an API</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Remove-AzureRmAzureRmApiManagementApi -Context $apimContext -ApiId "0123456789"</dev:code> <dev:remarks><maml:para>This command removes the API with the specified ID. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementapi</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Export-AzureRmApiManagementApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Import-AzureRmApiManagementApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Remove-AzureRmApiManagementApiFromProduct</command:name> <command:verb>Remove</command:verb> <command:noun>AzureRmApiManagementApiFromProduct</command:noun> <maml:description><maml:para>Removes an API from a product. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Remove-AzureRmApiManagementApiFromProduct cmdlet removes an Azure API Management API from a product. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Remove-AzureRmApiManagementApiFromProduct</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies the ID of the API to remove from the product. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext . </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a value of $True if it succeeds, or $False, otherwise. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductId</maml:name> <maml:Description><maml:para>Specifies the ID of the product from which to remove the API. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies the ID of the API to remove from the product. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext . </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a value of $True if it succeeds, or $False, otherwise. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductId</maml:name> <maml:Description><maml:para>Specifies the ID of the product from which to remove the API. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>bool</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Remove an API from a product</maml:title> <dev:code>PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Remove-AzureRmApiManagementApiFromProduct -Context $ApiMgmtContext -ProductId "0123456789" -ApiId "0001" -PassThru</dev:code> <dev:remarks><maml:para>This commnd removes the specified API from a product. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementapifromproduct</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Add-AzureRmApiManagementApiToProduct</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Remove-AzureRmApiManagementAuthorizationServer</command:name> <command:verb>Remove</command:verb> <command:noun>AzureRmApiManagementAuthorizationServer</command:noun> <maml:description><maml:para>Removes an authorization server. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Remove-AzureRmApiManagementAuthorizationServer cmdlet removes an Azure API Management authorization server. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Remove-AzureRmApiManagementAuthorizationServer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ServerId</maml:name> <maml:Description><maml:para>Specifies the ID of the authorization server to remove. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ServerId</maml:name> <maml:Description><maml:para>Specifies the ID of the authorization server to remove. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Boolean</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples></command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementauthorizationserver</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementAuthorizationServer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementAuthorizationServer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementAuthorizationServer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Remove-AzureRmApiManagementBackend</command:name> <command:verb>Remove</command:verb> <command:noun>AzureRmApiManagementBackend</command:noun> <maml:description><maml:para>Removes a Backend. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Removes a backend specified by the Identifier from the Api Management. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Remove-AzureRmApiManagementBackend</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>BackendId</maml:name> <maml:Description><maml:para>Identifier of existing backend. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Instance of PsApiManagementContext. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>If specified will write true in case operation succeeds. This parameter is optional. Default value is false. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>BackendId</maml:name> <maml:Description><maml:para>Identifier of existing backend. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Instance of PsApiManagementContext. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>If specified will write true in case operation succeeds. This parameter is optional. Default value is false. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>bool</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Remove the Backend 123</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Remove-AzureRmApiManagementBackend -Context $apimContext -BackendId 123 -PassThru</dev:code> <dev:remarks><maml:para> </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementbackend</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementBackend</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementBackend</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementBackendCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementBackendProxy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementBackend</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Remove-AzureRmApiManagementCertificate</command:name> <command:verb>Remove</command:verb> <command:noun>AzureRmApiManagementCertificate</command:noun> <maml:description><maml:para>Removes an API Management certificate. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Remove-AzureRmApiManagementCertificate cmdlet removes an Azure API Management certificate. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Remove-AzureRmApiManagementCertificate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>CertificateId</maml:name> <maml:Description><maml:para>Specifies the ID of the certificate to remove. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>CertificateId</maml:name> <maml:Description><maml:para>Specifies the ID of the certificate to remove. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Boolean</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Remove a certificate</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Remove-AzureRmApiManagementCertificate -Context $ApiMgmtContext -CertificateId "0123456789" -Force</dev:code> <dev:remarks><maml:para>This command removes the specified API Management certificate. Because the Force parameter is specified, no confirmation is required. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementcertificate</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Remove-AzureRmApiManagementGroup</command:name> <command:verb>Remove</command:verb> <command:noun>AzureRmApiManagementGroup</command:noun> <maml:description><maml:para>Removes an existing API management group. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Remove-AzureRmApiManagementGroup cmdlet removes an existing API management group. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Remove-AzureRmApiManagementGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies the instance of a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>GroupId</maml:name> <maml:Description><maml:para>Specifies the identifier of a management group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a value of $True if it succeeds, or a value of $False, otherwise. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies the instance of a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>GroupId</maml:name> <maml:Description><maml:para>Specifies the identifier of a management group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a value of $True if it succeeds, or a value of $False, otherwise. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Boolean</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Remove an existing management group</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Remove-AzureRmApiManagementGroup -Context $apimContext -GroupId "Group0001" -Force</dev:code> <dev:remarks><maml:para>This command removes an existing management group named Group0001 and does not prompt the user for confirmation. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementgroup</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Remove-AzureRmApiManagementIdentityProvider</command:name> <command:verb>Remove</command:verb> <command:noun>AzureRmApiManagementIdentityProvider</command:noun> <maml:description><maml:para>Removes an existing Identity Provider Configuration. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Removes an existing Identity Provider Configuration. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Remove-AzureRmApiManagementIdentityProvider</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Instance of PsApiManagementContext. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a value of $True if the operation succeeds or $False otherwise. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Type</maml:name> <maml:Description><maml:para>Identifier of an existing Identity Provider. This parameter is required. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Facebook</command:parameterValue> <command:parameterValue required="false" variableLength="false">Google</command:parameterValue> <command:parameterValue required="false" variableLength="false">Microsoft</command:parameterValue> <command:parameterValue required="false" variableLength="false">Twitter</command:parameterValue> <command:parameterValue required="false" variableLength="false">Aad</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PsApiManagementIdentityProviderType</command:parameterValue> <dev:type><maml:name>PsApiManagementIdentityProviderType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Instance of PsApiManagementContext. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a value of $True if the operation succeeds or $False otherwise. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Type</maml:name> <maml:Description><maml:para>Identifier of an existing Identity Provider. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementIdentityProviderType</command:parameterValue> <dev:type><maml:name>PsApiManagementIdentityProviderType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>bool</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Removes the Facebook identity provider settings from ApiManagement service</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Remove-AzureRmApiManagementIdentityProvider -Context $apimContext -Type 'Facebook' -PassThru</dev:code> <dev:remarks><maml:para>Deletes configuration related to Facebook Identity provider configuration. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementidentityprovider</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementIdentityProvider</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementIdentityProvider</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementIdentityProvider</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Remove-AzureRmApiManagementLogger</command:name> <command:verb>Remove</command:verb> <command:noun>AzureRmApiManagementLogger</command:noun> <maml:description><maml:para>Removes an API Management Logger. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Remove-AzureRmApiManagementLogger cmdlet removes an Azure API Management Logger . </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Remove-AzureRmApiManagementLogger</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>LoggerId</maml:name> <maml:Description><maml:para>Specifies the ID of the logger to remove. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a value of $True if the operation succeeds or $False otherwise. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>LoggerId</maml:name> <maml:Description><maml:para>Specifies the ID of the logger to remove. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a value of $True if the operation succeeds or $False otherwise. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Boolean</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Remove a logger</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Remove-AzureRmApiManagementLogger -Context $apimContext -LoggerId "Logger123" -Force</dev:code> <dev:remarks><maml:para>This command removes a logger that has the ID Logger123. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementlogger</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementLogger</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementLogger</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementLogger</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Remove-AzureRmApiManagementOpenIdConnectProvider</command:name> <command:verb>Remove</command:verb> <command:noun>AzureRmApiManagementOpenIdConnectProvider</command:noun> <maml:description><maml:para>Removes an OpenID Connect provider. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Remove-AzureRmApiManagementOpenIdConnectProvider cmdlet removes an OpenID Connect provider for Azure API Management. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Remove-AzureRmApiManagementOpenIdConnectProvider</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OpenIdConnectProviderId</maml:name> <maml:Description><maml:para>Specifies an ID of the provider that this cmdlet removes. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a value of $True if the operation succeeds or $False otherwise. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OpenIdConnectProviderId</maml:name> <maml:Description><maml:para>Specifies an ID of the provider that this cmdlet removes. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a value of $True if the operation succeeds or $False otherwise. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Boolean</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Remove a provider</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Remove-AzureRmApiManagementOpenIdConnectProvider -Context $apimContext -OpenIdConnectProviderId "OICProvicer01" -PassThru</dev:code> <dev:remarks><maml:para>This command removes a provider that has the ID OICProvicer01. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementopenidconnectprovider</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementOpenIdConnectProvider</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementOpenIdConnectProvider</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementOpenIdConnectProvider</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Remove-AzureRmApiManagementOperation</command:name> <command:verb>Remove</command:verb> <command:noun>AzureRmApiManagementOperation</command:noun> <maml:description><maml:para>Removes an existing operation. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Remove-AzureRmApiManagementOperation cmdlet removes an existing operation. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Remove-AzureRmApiManagementOperation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies the identifier of the API. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies an instance of PsApiManagementContext . </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OperationId</maml:name> <maml:Description><maml:para>Specifies the identifier of the API operation. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a value of $True if it succeeds, or a value of $False, otherwise. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies the identifier of the API. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies an instance of PsApiManagementContext . </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OperationId</maml:name> <maml:Description><maml:para>Specifies the identifier of the API operation. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a value of $True if it succeeds, or a value of $False, otherwise. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>bool</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Remove an existing API Operation</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Remove-AzureRmApiManagementOperation -Context $apimContext -ApiId "0123456789" -OperationId "9876543210" -Force</dev:code> <dev:remarks><maml:para>This command removes an existing API Operation. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementoperation</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementOperation</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementOperation</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementOperation</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Remove-AzureRmApiManagementPolicy</command:name> <command:verb>Remove</command:verb> <command:noun>AzureRmApiManagementPolicy</command:noun> <maml:description><maml:para>Removes the API Management policy from a specified scope. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Remove-AzureRmApiManagementPolicy cmdlet removes the API Management policy from specified scope. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Remove-AzureRmApiManagementPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies the identifier of an existing API. If you specify this parameter, the cmdlet removes the API-scope policy. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies the instance of the PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a value of $True, if it succeeds, or a value of $False, otherwise. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Remove-AzureRmApiManagementPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies the identifier of an existing API. If you specify this parameter, the cmdlet removes the API-scope policy. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies the instance of the PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OperationId</maml:name> <maml:Description><maml:para>Specifies the identifier of an existing operation. If you specify this parameter with the ApiId parameter, this cmdlet removes the operation-scope policy. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a value of $True, if it succeeds, or a value of $False, otherwise. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Remove-AzureRmApiManagementPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies the instance of the PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a value of $True, if it succeeds, or a value of $False, otherwise. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductId</maml:name> <maml:Description><maml:para>Specifies the identifier of the existing product. If you specify this parameter, the cmdlet removes the product-scope policy. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies the identifier of an existing API. If you specify this parameter, the cmdlet removes the API-scope policy. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies the instance of the PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OperationId</maml:name> <maml:Description><maml:para>Specifies the identifier of an existing operation. If you specify this parameter with the ApiId parameter, this cmdlet removes the operation-scope policy. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a value of $True, if it succeeds, or a value of $False, otherwise. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductId</maml:name> <maml:Description><maml:para>Specifies the identifier of the existing product. If you specify this parameter, the cmdlet removes the product-scope policy. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Boolean</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Remove the tenant level policy</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Remove-AzureRmApiManagementPolicy -Context $apimContext</dev:code> <dev:remarks><maml:para>This command removes tenant level policy from API Management. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Remove the product-scope policy</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Remove-AzureRmApiManagementPolicy -Context $apimContext -ProductId "0123456789"</dev:code> <dev:remarks><maml:para>This command removes product-scope policy from API Management. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 3: Remove the API-scope policy</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Remove-AzureRmApiManagementPolicy -Context $apimContext -ApiId "9876543210"</dev:code> <dev:remarks><maml:para>This command removes API-scope policy from API Management. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 4: Remove the operation-scope policy</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Remove-AzureRmApiManagementPolicy -Context $apimContext -ApiId "9876543210" -OperationId "777"</dev:code> <dev:remarks><maml:para>This command removes operation-scope policy from API Management. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementpolicy</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Remove-AzureRmApiManagementProduct</command:name> <command:verb>Remove</command:verb> <command:noun>AzureRmApiManagementProduct</command:noun> <maml:description><maml:para>Removes an existing API Management product. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Remove-AzureRmApiManagementProduct cmdlet removes an existing API Management product. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Remove-AzureRmApiManagementProduct</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies an instance of the PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>DeleteSubscriptions</maml:name> <maml:Description><maml:para>Indicates whether to delete subscriptions to the product. If you do not set this parameter and subscriptions exists, an exception is thrown. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a value of $True, if it succeeds, or a value of $False, if it fails. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductId</maml:name> <maml:Description><maml:para>Specifies the identifier of the existing product. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies an instance of the PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>DeleteSubscriptions</maml:name> <maml:Description><maml:para>Indicates whether to delete subscriptions to the product. If you do not set this parameter and subscriptions exists, an exception is thrown. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a value of $True, if it succeeds, or a value of $False, if it fails. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductId</maml:name> <maml:Description><maml:para>Specifies the identifier of the existing product. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>bool</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Remove an existing product and all subscriptions</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Remove-AzureRmApiManagementProduct -Context $apimContext -Id "0123456789" -DeleteSubscriptions -Force</dev:code> <dev:remarks><maml:para>This command removes an existing product and all subscriptions. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementproduct</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementProduct</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementProduct</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementProduct</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Remove-AzureRmApiManagementProductFromGroup</command:name> <command:verb>Remove</command:verb> <command:noun>AzureRmApiManagementProductFromGroup</command:noun> <maml:description><maml:para>Removes a product from a group. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Remove-AzureRmApiManagementProductFromGroup cmdlet removes a product from an existing group. In other words, this cmdlet removes the group assignment from a product. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Remove-AzureRmApiManagementProductFromGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>GroupId</maml:name> <maml:Description><maml:para>Specifies the group ID. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a value of $True, if it succeeds, or $False, otherwise. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductId</maml:name> <maml:Description><maml:para>Specifies the product ID. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>GroupId</maml:name> <maml:Description><maml:para>Specifies the group ID. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a value of $True, if it succeeds, or $False, otherwise. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductId</maml:name> <maml:Description><maml:para>Specifies the product ID. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>System.Boolean</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Remove a product from a group</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Remove-AzureRmApiManagementProductFromGroup -Context $apimContext -GroupId "0001" -ProductId "0123456789"</dev:code> <dev:remarks><maml:para>This command removes a product from an existing group. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementproductfromgroup</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Add-AzureRmApiManagementProductToGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Remove-AzureRmApiManagementProperty</command:name> <command:verb>Remove</command:verb> <command:noun>AzureRmApiManagementProperty</command:noun> <maml:description><maml:para>Removes an API Management Property. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Remove-AzureRmApiManagementProperty cmdlet removes an Azure API Management Property . </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Remove-AzureRmApiManagementProperty</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a value of $True if the operation succeeds or $False otherwise. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PropertyId</maml:name> <maml:Description><maml:para>Specifies an ID of the property that this cmdlet removes. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a value of $True if the operation succeeds or $False otherwise. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PropertyId</maml:name> <maml:Description><maml:para>Specifies an ID of the property that this cmdlet removes. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>bool</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Remove a property</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Remove-AzureRmApiManagementProperty -Context $apimContext -PropertyId "Property11" -PassThru</dev:code> <dev:remarks><maml:para>This command removes the property that has the ID Property11. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementproperty</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Remove-AzureRmApiManagementSubscription</command:name> <command:verb>Remove</command:verb> <command:noun>AzureRmApiManagementSubscription</command:noun> <maml:description><maml:para>Deletes an existing subscription. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Remove-AzureRmApiManagementSubscription cmdlet deletes an existing subscription. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Remove-AzureRmApiManagementSubscription</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a value of $True, if it succeeds, or a value of $false, otherwise. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SubscriptionId</maml:name> <maml:Description><maml:para>Specifies the subscription ID. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a value of $True, if it succeeds, or a value of $false, otherwise. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SubscriptionId</maml:name> <maml:Description><maml:para>Specifies the subscription ID. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Boolean</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Delete a subscription</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Remove-AzureRmApiManagementSubscription -Context $apimContext -SubscriptionId "0123456789" -Force</dev:code> <dev:remarks><maml:para>This command deletes an existing subscription. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementsubscription</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementSubscription</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementSubscription</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementSubscription</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Remove-AzureRmApiManagementUser</command:name> <command:verb>Remove</command:verb> <command:noun>AzureRmApiManagementUser</command:noun> <maml:description><maml:para>Deletes an existing user. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Remove-AzureRmApiManagementUser cmdlet deletes an existing user. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Remove-AzureRmApiManagementUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>DeleteSubscriptions</maml:name> <maml:Description><maml:para>Indicates whether to delete subscriptions to the product. If this parameter is not specified and a subscription exists, this cmdlet throws an exception. This parameter is optional. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a value of $Ture, if it succeeds, or a value of $False, otherwise. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>UserId</maml:name> <maml:Description><maml:para>Specifies the ID of the user to remove. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>DeleteSubscriptions</maml:name> <maml:Description><maml:para>Indicates whether to delete subscriptions to the product. If this parameter is not specified and a subscription exists, this cmdlet throws an exception. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a value of $Ture, if it succeeds, or a value of $False, otherwise. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>UserId</maml:name> <maml:Description><maml:para>Specifies the ID of the user to remove. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Boolean</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Delete a user</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Remove-AzureRmApiManagementUser -Context $apimContext -UserId "0123456789" -Force</dev:code> <dev:remarks><maml:para>This command deletes an existing user. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementuser</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Set-AzureRmApiManagementUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Remove-AzureRmApiManagementUserFromGroup</command:name> <command:verb>Remove</command:verb> <command:noun>AzureRmApiManagementUserFromGroup</command:noun> <maml:description><maml:para>Removes a user from a group. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Remove-AzureRmApiManagementUserFromGroup cmdlet removes a user from an existing group. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Remove-AzureRmApiManagementUserFromGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>GroupId</maml:name> <maml:Description><maml:para>Specifies the ID of the group from which to remove a user. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a value of $True, if it succeeds, or a value of $False, otherwise. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>UserId</maml:name> <maml:Description><maml:para>Specifies the ID of the user to remove from the group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>GroupId</maml:name> <maml:Description><maml:para>Specifies the ID of the group from which to remove a user. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a value of $True, if it succeeds, or a value of $False, otherwise. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>UserId</maml:name> <maml:Description><maml:para>Specifies the ID of the user to remove from the group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>System.Boolean</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Remove a user from a group</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Remove-AzureRmApiManagementUserFromGroup -Context $apimContext -GroupId "0001" -UserId "0123456789"</dev:code> <dev:remarks><maml:para>This command removes a user from a group. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/remove-azurermapimanagementuserfromgroup</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Add-AzureRmApiManagementUserToGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Save-AzureRmApiManagementTenantGitConfiguration</command:name> <command:verb>Save</command:verb> <command:noun>AzureRmApiManagementTenantGitConfiguration</command:noun> <maml:description><maml:para>Saves changes by creating a commit for current configuration. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Save-AzureRmApiManagementTenantGitConfiguration cmdlet saves the changes by creating a commit that contains the current configuration snapshot to a branch in the repository. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Save-AzureRmApiManagementTenantGitConfiguration</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Branch</maml:name> <maml:Description><maml:para>Specifies the name of the Git branch in which to commit the current configuration snapshot. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Specifies that this cmdlet commits the current configuration database to the Git repository, even if the Git repository has newer changes that are overwritten. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a PsApiManagementOperationResult object. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Branch</maml:name> <maml:Description><maml:para>Specifies the name of the Git branch in which to commit the current configuration snapshot. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Force</maml:name> <maml:Description><maml:para>Specifies that this cmdlet commits the current configuration database to the Git repository, even if the Git repository has newer changes that are overwritten. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns a PsApiManagementOperationResult object. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOperationResult</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Save changes to configuration</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Save-AzureRmApiManagementTenantGitConfiguration -Context $apimContext -Branch 'master' -PassThru</dev:code> <dev:remarks><maml:para>This command saves the changes by creating a commit with the current configuration snapshot to the specified branch in the repository. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/save-azurermapimanagementtenantgitconfiguration</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Publish-AzureRmApiManagementTenantGitConfiguration</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-AzureRmApiManagementApi</command:name> <command:verb>Set</command:verb> <command:noun>AzureRmApiManagementApi</command:noun> <maml:description><maml:para>Modifies an API. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Set-AzureRmApiManagementApi cmdlet modifies an Azure API Management API. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-AzureRmApiManagementApi</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies the ID of the API to modify. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AuthorizationScope</maml:name> <maml:Description><maml:para>Specifies the OAuth operations scope. The default value is $Null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AuthorizationServerId</maml:name> <maml:Description><maml:para>Specifies the OAuth authorization server identifier. The default value is $Null. You must specify this parameter if AuthorizationScope is specified. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Specifies a description for the web API. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the web API. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Path</maml:name> <maml:Description><maml:para>Specifies the web API path, which is the last part of the API's public URL. This URL is used by API consumers to send requests to the web service, and must be one to 400 characters long. The default value is $Null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Protocols</maml:name> <maml:Description><maml:para>Specifies an array of web API protocols. psdx_paramvalues http and https. These are the web protocols over which the API is made available. The default value is $Null. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Http</command:parameterValue> <command:parameterValue required="false" variableLength="false">Https</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PsApiManagementSchema[]</command:parameterValue> <dev:type><maml:name>PsApiManagementSchema[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ServiceUrl</maml:name> <maml:Description><maml:para>Specifies the URL of the web service that exposes the API. This URL is used only by Azure API Management, and is not made public. The URL must be one to 2000 characters long. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SubscriptionKeyHeaderName</maml:name> <maml:Description><maml:para>Specifies the name of the subscription key header. The default value is $Null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SubscriptionKeyQueryParamName</maml:name> <maml:Description><maml:para>Specifies the name of the subscription key query string parameter. The default value is $Null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies the ID of the API to modify. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AuthorizationScope</maml:name> <maml:Description><maml:para>Specifies the OAuth operations scope. The default value is $Null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AuthorizationServerId</maml:name> <maml:Description><maml:para>Specifies the OAuth authorization server identifier. The default value is $Null. You must specify this parameter if AuthorizationScope is specified. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Specifies a description for the web API. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the web API. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Path</maml:name> <maml:Description><maml:para>Specifies the web API path, which is the last part of the API's public URL. This URL is used by API consumers to send requests to the web service, and must be one to 400 characters long. The default value is $Null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Protocols</maml:name> <maml:Description><maml:para>Specifies an array of web API protocols. psdx_paramvalues http and https. These are the web protocols over which the API is made available. The default value is $Null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementSchema[]</command:parameterValue> <dev:type><maml:name>PsApiManagementSchema[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ServiceUrl</maml:name> <maml:Description><maml:para>Specifies the URL of the web service that exposes the API. This URL is used only by Azure API Management, and is not made public. The URL must be one to 2000 characters long. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SubscriptionKeyHeaderName</maml:name> <maml:Description><maml:para>Specifies the name of the subscription key header. The default value is $Null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SubscriptionKeyQueryParamName</maml:name> <maml:Description><maml:para>Specifies the name of the subscription key query string parameter. The default value is $Null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1 Modify an API</maml:title> <dev:code>PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Set-AzureRmApiManagementApi -Context $ApiMgmtContext -Name "EchoApi" -ServiceUrl "https://contoso.com/apis/echo" -Protocols @('https') -Description "Responds with what was sent" -Path "echo"</dev:code> <dev:remarks><maml:para> </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementapi</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Export-AzureRmApiManagementApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Import-AzureRmApiManagementApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementApi</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-AzureRmApiManagementAuthorizationServer</command:name> <command:verb>Set</command:verb> <command:noun>AzureRmApiManagementAuthorizationServer</command:noun> <maml:description><maml:para>Modifies an authorization server. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Set-AzureRmApiManagementAuthorizationServer cmdlet modifies Azure API Management authorization server details. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-AzureRmApiManagementAuthorizationServer</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AccessTokenSendingMethods</maml:name> <maml:Description><maml:para>Specifies an array of methods to send an access token. psdx_paramvalues AuthorizationHeader and Query. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">AuthorizationHeader</command:parameterValue> <command:parameterValue required="false" variableLength="false">Query</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PsApiManagementAccessTokenSendingMethod[]</command:parameterValue> <dev:type><maml:name>PsApiManagementAccessTokenSendingMethod[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AuthorizationEndpointUrl</maml:name> <maml:Description><maml:para>Specifies the authorization endpoint to authenticate resource owners and obtain authorization grants. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AuthorizationRequestMethods</maml:name> <maml:Description><maml:para>Specifies an array of authorization request methods. psdx_paramvalues GET and POST. The default value is GET. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Get</command:parameterValue> <command:parameterValue required="false" variableLength="false">Post</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PsApiManagementAuthorizationRequestMethod[]</command:parameterValue> <dev:type><maml:name>PsApiManagementAuthorizationRequestMethod[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientAuthenticationMethods</maml:name> <maml:Description><maml:para>Specifies an array of client authentication methods. psdx_paramvalues Basic and Body. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Basic</command:parameterValue> <command:parameterValue required="false" variableLength="false">Body</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PsApiManagementClientAuthenticationMethod[]</command:parameterValue> <dev:type><maml:name>PsApiManagementClientAuthenticationMethod[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientId</maml:name> <maml:Description><maml:para>Specifies the client ID of the developer console that is the client application. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientRegistrationPageUrl</maml:name> <maml:Description><maml:para>Specifies the client registration endpoint to register clients with the authorization server and obtain client credentials. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientSecret</maml:name> <maml:Description><maml:para>Specifies the client secret of the developer console that is the client application. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>DefaultScope</maml:name> <maml:Description><maml:para>Specifies the default scope for the authorization server. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Specifies a description for an authorization server. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>GrantTypes</maml:name> <maml:Description><maml:para>Specifies an array of grant types. psdx_paramvalues </maml:para> <maml:para>- AuthorizationCode </maml:para> <maml:para>- ClientCredentials </maml:para> <maml:para>- Implicit </maml:para> <maml:para>- ResourceOwnerPassword </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">AuthorizationCode</command:parameterValue> <command:parameterValue required="false" variableLength="false">Implicit</command:parameterValue> <command:parameterValue required="false" variableLength="false">ResourceOwnerPassword</command:parameterValue> <command:parameterValue required="false" variableLength="false">ClientCredentials</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PsApiManagementGrantType[]</command:parameterValue> <dev:type><maml:name>PsApiManagementGrantType[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the authorization server to modify. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ResourceOwnerPassword</maml:name> <maml:Description><maml:para>Specifies the resource owner password. You must specify this parameter if ResourceOwnerPassword is specified by the GrantTypes parameter. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ResourceOwnerUsername</maml:name> <maml:Description><maml:para>Specifies the resource owner user name. You must specify this parameter if ResourceOwnerPassword is specified by the GrantTypes parameter. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ServerId</maml:name> <maml:Description><maml:para>Specifies the ID of the authorization server to modify. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SupportState</maml:name> <maml:Description><maml:para>Indicates whether to support the State parameter. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type><maml:name>Boolean</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>TokenBodyParameters</maml:name> <maml:Description><maml:para>Specifies additional body parameters using application/x-www-form-urlencoded format. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>TokenEndpointUrl</maml:name> <maml:Description><maml:para>Specifies the token endpoint for clients to obtain access tokens in exchange for presenting authorization grants or refresh tokens. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AccessTokenSendingMethods</maml:name> <maml:Description><maml:para>Specifies an array of methods to send an access token. psdx_paramvalues AuthorizationHeader and Query. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementAccessTokenSendingMethod[]</command:parameterValue> <dev:type><maml:name>PsApiManagementAccessTokenSendingMethod[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AuthorizationEndpointUrl</maml:name> <maml:Description><maml:para>Specifies the authorization endpoint to authenticate resource owners and obtain authorization grants. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AuthorizationRequestMethods</maml:name> <maml:Description><maml:para>Specifies an array of authorization request methods. psdx_paramvalues GET and POST. The default value is GET. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementAuthorizationRequestMethod[]</command:parameterValue> <dev:type><maml:name>PsApiManagementAuthorizationRequestMethod[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientAuthenticationMethods</maml:name> <maml:Description><maml:para>Specifies an array of client authentication methods. psdx_paramvalues Basic and Body. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementClientAuthenticationMethod[]</command:parameterValue> <dev:type><maml:name>PsApiManagementClientAuthenticationMethod[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientId</maml:name> <maml:Description><maml:para>Specifies the client ID of the developer console that is the client application. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientRegistrationPageUrl</maml:name> <maml:Description><maml:para>Specifies the client registration endpoint to register clients with the authorization server and obtain client credentials. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientSecret</maml:name> <maml:Description><maml:para>Specifies the client secret of the developer console that is the client application. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>DefaultScope</maml:name> <maml:Description><maml:para>Specifies the default scope for the authorization server. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Specifies a description for an authorization server. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>GrantTypes</maml:name> <maml:Description><maml:para>Specifies an array of grant types. psdx_paramvalues </maml:para> <maml:para>- AuthorizationCode </maml:para> <maml:para>- ClientCredentials </maml:para> <maml:para>- Implicit </maml:para> <maml:para>- ResourceOwnerPassword </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementGrantType[]</command:parameterValue> <dev:type><maml:name>PsApiManagementGrantType[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the authorization server to modify. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ResourceOwnerPassword</maml:name> <maml:Description><maml:para>Specifies the resource owner password. You must specify this parameter if ResourceOwnerPassword is specified by the GrantTypes parameter. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ResourceOwnerUsername</maml:name> <maml:Description><maml:para>Specifies the resource owner user name. You must specify this parameter if ResourceOwnerPassword is specified by the GrantTypes parameter. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ServerId</maml:name> <maml:Description><maml:para>Specifies the ID of the authorization server to modify. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SupportState</maml:name> <maml:Description><maml:para>Indicates whether to support the State parameter. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type><maml:name>Boolean</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>TokenBodyParameters</maml:name> <maml:Description><maml:para>Specifies additional body parameters using application/x-www-form-urlencoded format. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type><maml:name>Hashtable</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>TokenEndpointUrl</maml:name> <maml:Description><maml:para>Specifies the token endpoint for clients to obtain access tokens in exchange for presenting authorization grants or refresh tokens. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOAuth2AuthrozationServer</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Modify an authorization server</maml:title> <dev:code>PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Set-AzureRmApiManagementAuthrizarionServer -Context $ApiMgmtContext -ServerId 0123456789 -Name "Contoso OAuth2 server" -ClientRegistrationPageUrl "https://contoso/signupv2" -AuthorizationEndpointUrl "https://contoso/authv2" -TokenEndpointUrl "https://contoso/tokenv2" -ClientId "clientid" -ClientSecret "e041ed1b660b4eadbad5a29d066e6e88" -AuthorizationRequestMethods @('Get') -GrantTypes @( 'AuthorizationCode', 'Implicit', 'ClientCredentials') -ClientAuthenticationMethods @('Basic') -TokenBodyParameters @{'par1'='val1'} -AccessTokenSendingMethods @('AuthorizationHeader')</dev:code> <dev:remarks><maml:para>This command modifies the specified API Management authorization server. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementauthorizationserver</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementAuthorizationServer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementAuthorizationServer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementAuthorizationServer</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-AzureRmApiManagementBackend</command:name> <command:verb>Set</command:verb> <command:noun>AzureRmApiManagementBackend</command:noun> <maml:description><maml:para>Updates a Backend. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Updates an existing backend in the Api Management. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-AzureRmApiManagementBackend</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>BackendId</maml:name> <maml:Description><maml:para>Identifier of new backend. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Instance of PsApiManagementContext. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Credential details which should be used when talking to the Backend. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementBackendCredential</command:parameterValue> <dev:type><maml:name>PsApiManagementBackendCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Backend Description. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns the PsApiManagementBackend that this cmdlet modifies. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Protocol</maml:name> <maml:Description><maml:para>Backend Communication protocol (http or soap). This parameter is optional </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">http</command:parameterValue> <command:parameterValue required="false" variableLength="false">soap</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Proxy</maml:name> <maml:Description><maml:para>Proxy Server details to be used while sending request to the Backend. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementBackendProxy</command:parameterValue> <dev:type><maml:name>PsApiManagementBackendProxy</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ResourceId</maml:name> <maml:Description><maml:para>Management Uri of the Resource in External System. This parameter is optional. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SkipCertificateChainValidation</maml:name> <maml:Description><maml:para>Whether to Skip Certificate Chain Validation when talking to the Backend. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type><maml:name>Boolean</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SkipCertificateNameValidation</maml:name> <maml:Description><maml:para>Whether to skip Certificate Name Validation when talking to the Backend. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type><maml:name>Boolean</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Title</maml:name> <maml:Description><maml:para>Backend Title. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Url</maml:name> <maml:Description><maml:para>Runtime Url for the Backend. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>BackendId</maml:name> <maml:Description><maml:para>Identifier of new backend. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Instance of PsApiManagementContext. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Credential</maml:name> <maml:Description><maml:para>Credential details which should be used when talking to the Backend. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementBackendCredential</command:parameterValue> <dev:type><maml:name>PsApiManagementBackendCredential</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Backend Description. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns the PsApiManagementBackend that this cmdlet modifies. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Protocol</maml:name> <maml:Description><maml:para>Backend Communication protocol (http or soap). This parameter is optional </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Proxy</maml:name> <maml:Description><maml:para>Proxy Server details to be used while sending request to the Backend. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementBackendProxy</command:parameterValue> <dev:type><maml:name>PsApiManagementBackendProxy</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ResourceId</maml:name> <maml:Description><maml:para>Management Uri of the Resource in External System. This parameter is optional. This url can be the Arm Resource Id of Logic Apps, Function Apps or Api Apps. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SkipCertificateChainValidation</maml:name> <maml:Description><maml:para>Whether to Skip Certificate Chain Validation when talking to the Backend. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type><maml:name>Boolean</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SkipCertificateNameValidation</maml:name> <maml:Description><maml:para>Whether to skip Certificate Name Validation when talking to the Backend. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type><maml:name>Boolean</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Title</maml:name> <maml:Description><maml:para>Backend Title. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Url</maml:name> <maml:Description><maml:para>Runtime Url for the Backend. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementBackend</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Updates the Description of the Backend 123</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Set-AzureRmApiManagementBackend -Context $apimContext -BackendId 123 -Description "updated description" -PassThru</dev:code> <dev:remarks><maml:para> </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementbackend</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementBackend</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementBackend</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementBackendCredential</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementBackendProxy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementBackend</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-AzureRmApiManagementCertificate</command:name> <command:verb>Set</command:verb> <command:noun>AzureRmApiManagementCertificate</command:noun> <maml:description><maml:para>Modifies an API Management certificate which is configured for mutual authentication with backend. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Set-AzureRmApiManagementCertificate cmdlet modifies an Azure API Management certificate. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-AzureRmApiManagementCertificate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>CertificateId</maml:name> <maml:Description><maml:para>Specifies the ID of the certificate to modify. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PfxBytes</maml:name> <maml:Description><maml:para>Specifies an array of bytes of the certificate file in .pfx format. This parameter is required if you do not specify the PfxFilePath parameter. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Byte[]</command:parameterValue> <dev:type><maml:name>Byte[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PfxPassword</maml:name> <maml:Description><maml:para>Specifies the password for the certificate. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Set-AzureRmApiManagementCertificate</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>CertificateId</maml:name> <maml:Description><maml:para>Specifies the ID of the certificate to modify. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PfxFilePath</maml:name> <maml:Description><maml:para>Specifies the path to the certificate file in .pfx format to create and upload. This parameter is required if you do not specify the PfxBytes parameter. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PfxPassword</maml:name> <maml:Description><maml:para>Specifies the password for the certificate. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>CertificateId</maml:name> <maml:Description><maml:para>Specifies the ID of the certificate to modify. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PfxBytes</maml:name> <maml:Description><maml:para>Specifies an array of bytes of the certificate file in .pfx format. This parameter is required if you do not specify the PfxFilePath parameter. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Byte[]</command:parameterValue> <dev:type><maml:name>Byte[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PfxFilePath</maml:name> <maml:Description><maml:para>Specifies the path to the certificate file in .pfx format to create and upload. This parameter is required if you do not specify the PfxBytes parameter. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PfxPassword</maml:name> <maml:Description><maml:para>Specifies the password for the certificate. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementCertificate</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Modify a certificate</maml:title> <dev:code>PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Set-AzureRmApiManagementCertificate -Context $ApiMgmtContext -CertificateId "0123456789" -PfxFilePath "C:\contoso\certificates\apimanagementnew.pfx" -PfxPassword "2222"</dev:code> <dev:remarks><maml:para>This command modifies the specified API Management certificate. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementcertificate</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementCertificate</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-AzureRmApiManagementGroup</command:name> <command:verb>Set</command:verb> <command:noun>AzureRmApiManagementGroup</command:noun> <maml:description><maml:para>Configures an API management group. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Set-AzureRmApiManagementGroup cmdlet configures an API management group. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-AzureRmApiManagementGroup</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies an instance of a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Specifies the description of the management group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>GroupId</maml:name> <maml:Description><maml:para>Specifies the identifier of the management group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the management group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies an instance of a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Specifies the description of the management group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>GroupId</maml:name> <maml:Description><maml:para>Specifies the identifier of the management group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the management group. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGroup</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Configure a management group</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Set-AzureRmApiManagementGroup -Context $apimContext -Description "Updated Management Group" -Name "Group0001"</dev:code> <dev:remarks><maml:para>This command configures a management group named Group0001. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementgroup</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementGroup</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-AzureRmApiManagementIdentityProvider</command:name> <command:verb>Set</command:verb> <command:noun>AzureRmApiManagementIdentityProvider</command:noun> <maml:description><maml:para>Updates the Configuration of an existing Identity Provider. </maml:para> </maml:description> </command:details> <maml:description><maml:para>Updates the Configuration of an existing Identity Provider. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-AzureRmApiManagementIdentityProvider</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AllowedTenants</maml:name> <maml:Description><maml:para>List of allowed Azure Active Directory Tenants. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientId</maml:name> <maml:Description><maml:para>Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientSecret</maml:name> <maml:Description><maml:para>Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Instance of PsApiManagementContext. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns the PsApiManagementIdentityProvider that this cmdlet modifies. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Type</maml:name> <maml:Description><maml:para>Identifier of an existing Identity Provider. This parameter is required. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Facebook</command:parameterValue> <command:parameterValue required="false" variableLength="false">Google</command:parameterValue> <command:parameterValue required="false" variableLength="false">Microsoft</command:parameterValue> <command:parameterValue required="false" variableLength="false">Twitter</command:parameterValue> <command:parameterValue required="false" variableLength="false">Aad</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PsApiManagementIdentityProviderType</command:parameterValue> <dev:type><maml:name>PsApiManagementIdentityProviderType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>AllowedTenants</maml:name> <maml:Description><maml:para>List of allowed Azure Active Directory Tenants. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientId</maml:name> <maml:Description><maml:para>Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientSecret</maml:name> <maml:Description><maml:para>Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Instance of PsApiManagementContext. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns the PsApiManagementIdentityProvider that this cmdlet modifies. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Type</maml:name> <maml:Description><maml:para>Identifier of an existing Identity Provider. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementIdentityProviderType</command:parameterValue> <dev:type><maml:name>PsApiManagementIdentityProviderType</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="cf"><maml:name>Confirm</maml:name> <maml:Description><maml:para>Prompts you for confirmation before running the cmdlet. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="wi"><maml:name>WhatIf</maml:name> <maml:Description><maml:para>Shows what would happen if the cmdlet runs. The cmdlet is not run. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementIdentityProvider</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\> Set-AzureRmApiManagementIdentityProvider -Context $apimContext -Type Facebook -ClientSecret "updatedSecret" -PassThru</dev:code> <dev:remarks><maml:para>The cmdlet updates the Client Secret of the Facebook Identity Provider; </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementidentityprovider</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementIdentityProvider</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementIdentityProvider</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementIdentityProvider</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-AzureRmApiManagementLogger</command:name> <command:verb>Set</command:verb> <command:noun>AzureRmApiManagementLogger</command:noun> <maml:description><maml:para>Modifies an API Management Logger. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Set-AzureRmApiManagementLogger cmdlet modifies settings of an Azure API Management Logger . </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-AzureRmApiManagementLogger</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ConnectionString</maml:name> <maml:Description><maml:para>Specifies an Azure Event Hubs connection string that includes Send policy rights. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Specifies a description. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>IsBuffered</maml:name> <maml:Description><maml:para>Specifies that the records in the logger are buffered before publishing. When records are buffered, they are sent to Event Hubs every 15 seconds, or whenever the buffer receives 256 KB of messages. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>LoggerId</maml:name> <maml:Description><maml:para>Specifies the ID of the logger to update. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the entity name of an event hub from Azure classic portal. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns the PsApiManagementLogger that this cmdlet modifies. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ConnectionString</maml:name> <maml:Description><maml:para>Specifies an Azure Event Hubs connection string that includes Send policy rights. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Specifies a description. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>IsBuffered</maml:name> <maml:Description><maml:para>Specifies that the records in the logger are buffered before publishing. When records are buffered, they are sent to Event Hubs every 15 seconds, or whenever the buffer receives 256 KB of messages. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>LoggerId</maml:name> <maml:Description><maml:para>Specifies the ID of the logger to update. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the entity name of an event hub from Azure classic portal. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns the PsApiManagementLogger that this cmdlet modifies. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementLogger</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Modify a logger</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Set-AzureRmApiManagementLogger -Context $apimContext -LoggerId "Logger123" -Name "ContosoSdkEventHub" -ConnectionString "Endpoint=sb://ContosoSdkEventHubs.servicebus.windows.net/;SharedAccessKeyName=SendKey;SharedAccessKey=<key>" -Description "updated SDK event hub logger" -PassThru</dev:code> <dev:remarks><maml:para>This command modifies a logger that has the ID Logger123. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementlogger</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementLogger</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementLogger</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementLogger</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-AzureRmApiManagementOpenIdConnectProvider</command:name> <command:verb>Set</command:verb> <command:noun>AzureRmApiManagementOpenIdConnectProvider</command:noun> <maml:description><maml:para>Modifies an OpenID Connect provider. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Set-AzureRmApiManagementOpenIdConnectProvider cmdlet modifies an OpenID Connect provider in Azure API Management. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-AzureRmApiManagementOpenIdConnectProvider</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientId</maml:name> <maml:Description><maml:para>Specifies the client ID of the developer console. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientSecret</maml:name> <maml:Description><maml:para>Specifies the client secret of the developer console. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Specifies a description. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>MetadataEndpointUri</maml:name> <maml:Description><maml:para>Specifies a metadata endpoint URI of the provider. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies a friendly name for the provider. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OpenIdConnectProviderId</maml:name> <maml:Description><maml:para>Specifies an ID for the provider that this cmdlet modifies. If you do not specify an ID, this cmdlet generates one. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns the PsApiManagementOpenIdConnectProvider that this cmdlet modifies. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientId</maml:name> <maml:Description><maml:para>Specifies the client ID of the developer console. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ClientSecret</maml:name> <maml:Description><maml:para>Specifies the client secret of the developer console. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Specifies a description. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>MetadataEndpointUri</maml:name> <maml:Description><maml:para>Specifies a metadata endpoint URI of the provider. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies a friendly name for the provider. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OpenIdConnectProviderId</maml:name> <maml:Description><maml:para>Specifies an ID for the provider that this cmdlet modifies. If you do not specify an ID, this cmdlet generates one. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns the PsApiManagementOpenIdConnectProvider that this cmdlet modifies. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOpenIdConnectProvider</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Change the client secret for a provider</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Set-AzureRmApiManagementOpenIdConnectProvider -Context $apimContext -OpenIdConnectProviderId "OICProvicer01" -ClientSecret "q2w3e43r45" -PassThru</dev:code> <dev:remarks><maml:para>This command modifies the provider that has the ID OICProvicer01. The command specifies a client secret for the provider. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementopenidconnectprovider</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementOpenIdConnectProvider</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementOpenIdConnectProvider</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementOpenIdConnectProvider</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-AzureRmApiManagementOperation</command:name> <command:verb>Set</command:verb> <command:noun>AzureRmApiManagementOperation</command:noun> <maml:description><maml:para>Sets API operation details. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Set-AzureRmApiManagementOperation cmdlet sets API operation details. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-AzureRmApiManagementOperation</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies the identifier of the API. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies an instance of PsApiManagementContext . </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Specifies the description of the new operation. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Method</maml:name> <maml:Description><maml:para>Specifies the HTTP method of the new operation. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the display name of the new operation. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OperationId</maml:name> <maml:Description><maml:para>Specifies the identifier of the existing operation. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Request</maml:name> <maml:Description><maml:para>Specifies the operation request details. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementRequest</command:parameterValue> <dev:type><maml:name>PsApiManagementRequest</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Responses</maml:name> <maml:Description><maml:para>Specifies an array of possible operation responses. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementResponse[]</command:parameterValue> <dev:type><maml:name>PsApiManagementResponse[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>TemplateParameters</maml:name> <maml:Description><maml:para>Specifies an array or parameters defined in parameter UrlTemplate . If you do not specify a value, a default value will be generated based on the UrlTemplate. Use the parameter to give more details on parameters such as description, type, and other possible values. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementParameter[]</command:parameterValue> <dev:type><maml:name>PsApiManagementParameter[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>UrlTemplate</maml:name> <maml:Description><maml:para>Specifies the URL template. For instance: customers/{cid}/orders/{oid}/?date={date}. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies the identifier of the API. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies an instance of PsApiManagementContext . </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Specifies the description of the new operation. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Method</maml:name> <maml:Description><maml:para>Specifies the HTTP method of the new operation. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the display name of the new operation. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OperationId</maml:name> <maml:Description><maml:para>Specifies the identifier of the existing operation. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Request</maml:name> <maml:Description><maml:para>Specifies the operation request details. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementRequest</command:parameterValue> <dev:type><maml:name>PsApiManagementRequest</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Responses</maml:name> <maml:Description><maml:para>Specifies an array of possible operation responses. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementResponse[]</command:parameterValue> <dev:type><maml:name>PsApiManagementResponse[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>TemplateParameters</maml:name> <maml:Description><maml:para>Specifies an array or parameters defined in parameter UrlTemplate . If you do not specify a value, a default value will be generated based on the UrlTemplate. Use the parameter to give more details on parameters such as description, type, and other possible values. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementParameter[]</command:parameterValue> <dev:type><maml:name>PsApiManagementParameter[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>UrlTemplate</maml:name> <maml:Description><maml:para>Specifies the URL template. For instance: customers/{cid}/orders/{oid}/?date={date}. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOperation</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Set the operation details</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>New-AzureRmApiManagementOperation -Context $apimContext -ApiId $APIID -OperationId $OperationId -Name "Get Resource" -Method GET -UrlTemplate "/newresource" -Description "Use this operation to get newresource"</dev:code> <dev:remarks><maml:para>This command sets the operation details for API management. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementoperation</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementOperation</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementOperation</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementOperation</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-AzureRmApiManagementPolicy</command:name> <command:verb>Set</command:verb> <command:noun>AzureRmApiManagementPolicy</command:noun> <maml:description><maml:para>Sets the specified scope policy for API Management. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Set-AzureRmApiManagementPolicy cmdlet sets the specified scope policy for API Management. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-AzureRmApiManagementPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies the identifier of the existing API. If you specify this parameter, the cmdlet sets the API-scope policy. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies the instance of PsApiManagementContext . </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Format</maml:name> <maml:Description><maml:para>Specifies the format of the policy. The default value is "application/vnd.ms-azure-apim.policy+xml". </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Policy</maml:name> <maml:Description><maml:para>Specifies the policy document as a string. This parameter is required if the - PolicyFilePath is not specified. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PolicyFilePath</maml:name> <maml:Description><maml:para>Specifies the policy document file path. This parameter is required if the Policy parameter is not specified. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Set-AzureRmApiManagementPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies the identifier of the existing API. If you specify this parameter, the cmdlet sets the API-scope policy. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies the instance of PsApiManagementContext . </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Format</maml:name> <maml:Description><maml:para>Specifies the format of the policy. The default value is "application/vnd.ms-azure-apim.policy+xml". </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OperationId</maml:name> <maml:Description><maml:para>Specifies the identifier of the existing operation. If specified with ApiId will set operation-scope policy. This parameters is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Policy</maml:name> <maml:Description><maml:para>Specifies the policy document as a string. This parameter is required if the - PolicyFilePath is not specified. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PolicyFilePath</maml:name> <maml:Description><maml:para>Specifies the policy document file path. This parameter is required if the Policy parameter is not specified. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem><maml:name>Set-AzureRmApiManagementPolicy</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies the instance of PsApiManagementContext . </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Format</maml:name> <maml:Description><maml:para>Specifies the format of the policy. The default value is "application/vnd.ms-azure-apim.policy+xml". </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Policy</maml:name> <maml:Description><maml:para>Specifies the policy document as a string. This parameter is required if the - PolicyFilePath is not specified. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PolicyFilePath</maml:name> <maml:Description><maml:para>Specifies the policy document file path. This parameter is required if the Policy parameter is not specified. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductId</maml:name> <maml:Description><maml:para>Specifies the identifier of the existing product. If this parameter is specified, the cmdlet sets the product-scope policy. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApiId</maml:name> <maml:Description><maml:para>Specifies the identifier of the existing API. If you specify this parameter, the cmdlet sets the API-scope policy. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies the instance of PsApiManagementContext . </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Format</maml:name> <maml:Description><maml:para>Specifies the format of the policy. The default value is "application/vnd.ms-azure-apim.policy+xml". </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>OperationId</maml:name> <maml:Description><maml:para>Specifies the identifier of the existing operation. If specified with ApiId will set operation-scope policy. This parameters is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Policy</maml:name> <maml:Description><maml:para>Specifies the policy document as a string. This parameter is required if the - PolicyFilePath is not specified. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PolicyFilePath</maml:name> <maml:Description><maml:para>Specifies the policy document file path. This parameter is required if the Policy parameter is not specified. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductId</maml:name> <maml:Description><maml:para>Specifies the identifier of the existing product. If this parameter is specified, the cmdlet sets the product-scope policy. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>bool</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Set the tenant level policy</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Set-AzureRmApiManagementPolicy -Context $apimContext -PolicyFilePath "C:\contoso\policies\tenantpolicy.xml"</dev:code> <dev:remarks><maml:para>This command sets the tenant level policy from a file named tenantpolicy.xml. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Set a product-scope policy</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Set-AzureRmApiManagementPolicy -Context $apimContext -ProductId "0123456789" -Policy $PolicyString</dev:code> <dev:remarks><maml:para>This command sets the product-scope policy for API Management. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 3: Set API-scope policy</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Get-AzureRmApiManagementPolicy -Context $apimContext -ApiId "9876543210" -Policy $PolicyString</dev:code> <dev:remarks><maml:para>This command sets API-scope policy for API Management. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 4: Set operation-scope policy</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Set-AzureRmApiManagementPolicy -Context $apimContext -ApiId "9876543210" -OperationId "777" -Policy $PolicyString</dev:code> <dev:remarks><maml:para>This command sets operation-scope policy for API Management. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementpolicy</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementPolicy</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-AzureRmApiManagementProduct</command:name> <command:verb>Set</command:verb> <command:noun>AzureRmApiManagementProduct</command:noun> <maml:description><maml:para>Sets the API Management product details. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Set-AzureRmApiManagementProduct cmdlet sets the API Management product details. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-AzureRmApiManagementProduct</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApprovalRequired</maml:name> <maml:Description><maml:para>Indicates whether the subscription to the product requires approval. The default value is $False . </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type><maml:name>Boolean</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies an instance of the PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Specifies the product description. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>LegalTerms</maml:name> <maml:Description><maml:para>Specifies the legal terms of use of the product. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductId</maml:name> <maml:Description><maml:para>Specifies the identifier of the existing product. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>State</maml:name> <maml:Description><maml:para>Specifies the product state. psdx_paramvalues </maml:para> <maml:para>- NotPublished </maml:para> <maml:para>- Published </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">NotPublished</command:parameterValue> <command:parameterValue required="false" variableLength="false">Published</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PsApiManagementProductState</command:parameterValue> <dev:type><maml:name>PsApiManagementProductState</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SubscriptionRequired</maml:name> <maml:Description><maml:para>Indicates whether the product requires a subscription. The default value for this parameter is $True . </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type><maml:name>Boolean</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SubscriptionsLimit</maml:name> <maml:Description><maml:para>Specifies the maximum number of simultaneous subscriptions. The default value for this parameter is 1. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Title</maml:name> <maml:Description><maml:para>Specifies the product title this cmdlet sets. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ApprovalRequired</maml:name> <maml:Description><maml:para>Indicates whether the subscription to the product requires approval. The default value is $False . </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type><maml:name>Boolean</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies an instance of the PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Description</maml:name> <maml:Description><maml:para>Specifies the product description. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>LegalTerms</maml:name> <maml:Description><maml:para>Specifies the legal terms of use of the product. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ProductId</maml:name> <maml:Description><maml:para>Specifies the identifier of the existing product. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>State</maml:name> <maml:Description><maml:para>Specifies the product state. psdx_paramvalues </maml:para> <maml:para>- NotPublished </maml:para> <maml:para>- Published </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementProductState</command:parameterValue> <dev:type><maml:name>PsApiManagementProductState</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SubscriptionRequired</maml:name> <maml:Description><maml:para>Indicates whether the product requires a subscription. The default value for this parameter is $True . </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type><maml:name>Boolean</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SubscriptionsLimit</maml:name> <maml:Description><maml:para>Specifies the maximum number of simultaneous subscriptions. The default value for this parameter is 1. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type><maml:name>Int32</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Title</maml:name> <maml:Description><maml:para>Specifies the product title this cmdlet sets. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProduct</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Update the product details</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Set-AzureRmApiManagementProduct -Context $apimContext -ProductId "0123456789" -Title "Starter" -Description "Starter Product" -LegalTerms "Free for all" -SubscriptionRequired $True -State "NotPublished"</dev:code> <dev:remarks><maml:para>This command updates the API Management product details, requires a subscription, and then unpublishes. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementproduct</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementProduct</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementProduct</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementProduct</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-AzureRmApiManagementProperty</command:name> <command:verb>Set</command:verb> <command:noun>AzureRmApiManagementProperty</command:noun> <maml:description><maml:para>Modifies an API Management Property. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Set-AzureRmApiManagementProperty cmdlet modifies an Azure API Management Property. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-AzureRmApiManagementProperty</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the property. Maximum length is 100 characters. Names contain only letters, digits, period, dash, and underscore characters. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns the PsApiManagementProperty that this cmdlet modifies. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PropertyId</maml:name> <maml:Description><maml:para>Specifies an ID of the property that this cmdlet modifies. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Secret</maml:name> <maml:Description><maml:para>Indicates that the property value is a secret and should be encrypted. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type><maml:name>Boolean</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Tags"><maml:name>Tag</maml:name> <maml:Description><maml:para>Tags associated with a property. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Value</maml:name> <maml:Description><maml:para>Specifies a value for the property. This value can contain policy expressions. Maximum length is 1000 characters. The value may not be empty or consist only of whitespace. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies the name of the property. Maximum length is 100 characters. Names contain only letters, digits, period, dash, and underscore characters. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns the PsApiManagementProperty that this cmdlet modifies. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PropertyId</maml:name> <maml:Description><maml:para>Specifies an ID of the property that this cmdlet modifies. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Secret</maml:name> <maml:Description><maml:para>Indicates that the property value is a secret and should be encrypted. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type><maml:name>Boolean</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="Tags"><maml:name>Tag</maml:name> <maml:Description><maml:para>Tags associated with a property. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type><maml:name>String[]</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Value</maml:name> <maml:Description><maml:para>Specifies a value for the property. This value can contain policy expressions. Maximum length is 1000 characters. The value may not be empty or consist only of whitespace. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProperty</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Change the tags on a property</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>$Tags = 'sdk', 'powershell' PS C:\> Set-AzureRmApiManagementProperty -Context $apimContext -PropertyId "Property11" -Tags $Tags -PassThru</dev:code> <dev:remarks><maml:para>The first command assigns two values to the $Tags variable. </maml:para> <maml:para>The second command modifies the property that has the ID Property11. The command assigns the strings in $Tags as tags on the property. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> <command:example><maml:title>Example 2: Modify a property to have a secret value</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Set-AzureRmApiManagementProperty -Context $apimContext -PropertyId "Property12" -Secret $True -PassThru</dev:code> <dev:remarks><maml:para>This command changes the property to be Encrypted. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementproperty</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementProperty</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-AzureRmApiManagementSubscription</command:name> <command:verb>Set</command:verb> <command:noun>AzureRmApiManagementSubscription</command:noun> <maml:description><maml:para>Sets existing subscription details. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Set-AzureRmApiManagementSubscription cmdlet sets existing subscription details. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-AzureRmApiManagementSubscription</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ExpiresOn</maml:name> <maml:Description><maml:para>Specifies a subscription expiration date. The default value of this parameter is $Null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type><maml:name>DateTime</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies a subscription name. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PrimaryKey</maml:name> <maml:Description><maml:para>Specifies the subscription primary key. This parameter is generated automatically if not specified. This parameter must be 1 to 300 characters long. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SecondaryKey</maml:name> <maml:Description><maml:para>Specifies the subscription secondary key. This parameter is generated automatically if not specified. This parameter must be 1 to 300 characters long. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>State</maml:name> <maml:Description><maml:para>Specifies the subscription state. The default value of this parameter is $Null. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Suspended</command:parameterValue> <command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Expired</command:parameterValue> <command:parameterValue required="false" variableLength="false">Submitted</command:parameterValue> <command:parameterValue required="false" variableLength="false">Rejected</command:parameterValue> <command:parameterValue required="false" variableLength="false">Cancelled</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PsApiManagementSubscriptionState</command:parameterValue> <dev:type><maml:name>PsApiManagementSubscriptionState</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>StateComment</maml:name> <maml:Description><maml:para>Specifies the subscription state comment. The default value of this parameter is $Null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SubscriptionId</maml:name> <maml:Description><maml:para>Specifies the subscription ID. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>ExpiresOn</maml:name> <maml:Description><maml:para>Specifies a subscription expiration date. The default value of this parameter is $Null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DateTime</command:parameterValue> <dev:type><maml:name>DateTime</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Name</maml:name> <maml:Description><maml:para>Specifies a subscription name. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PrimaryKey</maml:name> <maml:Description><maml:para>Specifies the subscription primary key. This parameter is generated automatically if not specified. This parameter must be 1 to 300 characters long. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SecondaryKey</maml:name> <maml:Description><maml:para>Specifies the subscription secondary key. This parameter is generated automatically if not specified. This parameter must be 1 to 300 characters long. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>State</maml:name> <maml:Description><maml:para>Specifies the subscription state. The default value of this parameter is $Null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementSubscriptionState</command:parameterValue> <dev:type><maml:name>PsApiManagementSubscriptionState</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>StateComment</maml:name> <maml:Description><maml:para>Specifies the subscription state comment. The default value of this parameter is $Null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>SubscriptionId</maml:name> <maml:Description><maml:para>Specifies the subscription ID. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscripition</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Set the state and primary and secondary keys for a subscription</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Set-AzureRmApiManagementSubscription -Context $apimContext -SubscriptionId -0123456789 -PrimaryKey "80450f7d0b6d481382113073f67822c1" -SecondaryKey "97d6112c3a8f48d5bf0266b7a09a761c" -State "Active"</dev:code> <dev:remarks><maml:para>This command sets the primary and secondary keys for a subscription and activates it. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementsubscription</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementSubscription</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementSubscription</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementSubscription</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-AzureRmApiManagementTenantAccess</command:name> <command:verb>Set</command:verb> <command:noun>AzureRmApiManagementTenantAccess</command:noun> <maml:description><maml:para>Enables or disables tenant access. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Set-AzureRmApiManagementTenantAccess cmdlet enables or disables tenant access. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-AzureRmApiManagementTenantAccess</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Enabled</maml:name> <maml:Description><maml:para>Specifies whether this cmdlet enables or disables tenant access. Specify a value of $True to enable or $False to disable. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type><maml:name>Boolean</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns the PsApiManagementAccessInformation that this cmdlet modifies. </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"><maml:name>Enabled</maml:name> <maml:Description><maml:para>Specifies whether this cmdlet enables or disables tenant access. Specify a value of $True to enable or $False to disable. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Boolean</command:parameterValue> <dev:type><maml:name>Boolean</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>Indicates that this cmdlet returns the PsApiManagementAccessInformation that this cmdlet modifies. </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAccessInformation</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Enable tenant access</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>Set-AzureRmApiManagementTenantAccess -Context $apimContext -Enabled $True</dev:code> <dev:remarks><maml:para>This command enables tenant access in the specified context. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementtenantaccess</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementTenantAccess</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details><command:name>Set-AzureRmApiManagementUser</command:name> <command:verb>Set</command:verb> <command:noun>AzureRmApiManagementUser</command:noun> <maml:description><maml:para>Sets user details. </maml:para> </maml:description> </command:details> <maml:description><maml:para>The Set-AzureRmApiManagementUser cmdlet sets user details. </maml:para> </maml:description> <command:syntax><command:syntaxItem><maml:name>Set-AzureRmApiManagementUser</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Email</maml:name> <maml:Description><maml:para>Specifies the email address of the user. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>FirstName</maml:name> <maml:Description><maml:para>Specifies the first name of the user. This parameter must be 1 to 100 characters long. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>LastName</maml:name> <maml:Description><maml:para>Specifies the last name of the user. This parameter is must be 1 to 100 characters long. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Note</maml:name> <maml:Description><maml:para>Specifies a note about the user. This parameter is optional. The default value of this parameter is $null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Password</maml:name> <maml:Description><maml:para>Specifies the user password. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type><maml:name>SecureString</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>State</maml:name> <maml:Description><maml:para>Specifies the user state. This parameter is optional. The default value is Active. </maml:para> </maml:Description> <command:parameterValueGroup><command:parameterValue required="false" variableLength="false">Active</command:parameterValue> <command:parameterValue required="false" variableLength="false">Blocked</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">PsApiManagementUserState</command:parameterValue> <dev:type><maml:name>PsApiManagementUserState</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>UserId</maml:name> <maml:Description><maml:para>Specifies the user ID. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters><command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Context</maml:name> <maml:Description><maml:para>Specifies a PsApiManagementContext object. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue> <dev:type><maml:name>PsApiManagementContext</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="AzureRmContext, AzureCredential"><maml:name>DefaultProfile</maml:name> <maml:Description><maml:para>The credentials, account, tenant, and subscription used for communication with azure. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IAzureContextContainer</command:parameterValue> <dev:type><maml:name>IAzureContextContainer</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Email</maml:name> <maml:Description><maml:para>Specifies the email address of the user. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>FirstName</maml:name> <maml:Description><maml:para>Specifies the first name of the user. This parameter must be 1 to 100 characters long. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>LastName</maml:name> <maml:Description><maml:para>Specifies the last name of the user. This parameter is must be 1 to 100 characters long. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Note</maml:name> <maml:Description><maml:para>Specifies a note about the user. This parameter is optional. The default value of this parameter is $null. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>PassThru</maml:name> <maml:Description><maml:para>passthru </maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type><maml:name>SwitchParameter</maml:name> <maml:uri /></dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>Password</maml:name> <maml:Description><maml:para>Specifies the user password. This parameter is optional. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SecureString</command:parameterValue> <dev:type><maml:name>SecureString</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>State</maml:name> <maml:Description><maml:para>Specifies the user state. This parameter is optional. The default value is Active. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PsApiManagementUserState</command:parameterValue> <dev:type><maml:name>PsApiManagementUserState</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByPropertyName)" position="named" aliases="none"><maml:name>UserId</maml:name> <maml:Description><maml:para>Specifies the user ID. This parameter is required. </maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type><maml:name>String</maml:name> <maml:uri /></dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes><command:inputType><dev:type><maml:name>None</maml:name> </dev:type> <maml:description><maml:para>This cmdlet does not accept any input. </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues><command:returnValue><dev:type><maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUser</maml:name> </dev:type> <maml:description><maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet><maml:alert><maml:para> </maml:para> </maml:alert> </maml:alertSet> <command:examples><command:example><maml:title>Example 1: Change a user's password, email address and state</maml:title> <dev:code>PS C:\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso" PS C:\>$securePassword = ConvertTo-SecureString "qwerty" -AsPlainText -Force PS C:\>Set-AzureRmApiManagementUser -Context $apimContext -UserId "0123456789" -Email "patti.fuller@contoso.com" -Password $securePassword -State "Blocked"</dev:code> <dev:remarks><maml:para>This command sets a new user password and email address and blocks the user. </maml:para> <maml:para></maml:para> <maml:para></maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks><maml:navigationLink><maml:linkText>Online Version:</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/powershell/module/azurerm.apimanagement/set-azurermapimanagementuser</maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Get-AzureRmApiManagementUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>New-AzureRmApiManagementUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink><maml:linkText>Remove-AzureRmApiManagementUser</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |