Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems 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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Add-AzureRmApiManagementApiToProduct</command:name> <maml:description> <maml:para>Adds existing API to existing Product.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzureApiManagementApiToProduct</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Adds existing API to existing Product.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AzureRmApiManagementApiToProduct</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Identifier of existing Product to add API to. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier of existing APIs to be added to the product. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Identifier of existing Product to add API to. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier of existing APIs to be added to the product. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>bool</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Add-AzureRmApiManagementApiToProduct –Context $apimContext –ProductId 0123456789 –ApiId 0001</dev:code> <dev:remarks> <maml:para>Add existing API to an existing Product.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Add-AzureRmApiManagementProductToGroup</command:name> <maml:description> <maml:para>Adds existing product to existing group. In other words assigns a group to a product.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzureApiManagementProductToGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Adds existing product to existing group. In other words 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="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Identifier of existing group. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Identifier of existing product. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Identifier of existing group. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Identifier of existing product. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>bool</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Add-AzureRmApiManagementProductToGroup –Context $apimContext –GroupId 0001 –ProductId 0123456789</dev:code> <dev:remarks> <maml:para>Add existing product to an existing group.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Add-AzureRmApiManagementUserToGroup</command:name> <maml:description> <maml:para>Adds existing user to existing group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Add</command:verb> <command:noun>AzureApiManagementUserToGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Adds existing user to existing group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Add-AzureRmApiManagementUserToGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Identifier of existing group. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Identifier of existing user. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Identifier of existing group. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Identifier of existing user. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>bool</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Add-AzureRmApiManagementUserToGroup –Context $apimContext –GroupId 0001 –UserId 0123456789</dev:code> <dev:remarks> <maml:para>Add existing user to an existing group.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Export-AzureRmApiManagementApi</command:name> <maml:description> <maml:para>Export API to file in one of the supported formats.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Export</command:verb> <command:noun>AzureApiManagementApi</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Export API to 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="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier of exporting API. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SpecificationFormat</maml:name> <maml:description> <maml:para>Specification format (Wadl or Swagger). This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PsApiManagementApiFormat</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Export-AzureRmApiManagementApi</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier of exporting API. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SpecificationFormat</maml:name> <maml:description> <maml:para>Specification format (Wadl or Swagger). This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PsApiManagementApiFormat</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SaveAs</maml:name> <maml:description> <maml:para>File path where to save the exporting specification to. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If specified will override the file if it exists. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If specified will write true/false if api exported successfully/failed. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier of exporting API. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SpecificationFormat</maml:name> <maml:description> <maml:para>Specification format (Wadl or Swagger). This parameter is required.</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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SaveAs</maml:name> <maml:description> <maml:para>File path where to save the exporting specification to. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>If specified will override the file if it exists. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If specified will write true/false if api exported successfully/failed. 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> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>string</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> exported api content</maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para> true/false</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Export-AzureRmApiManagementApi –Context $apimContext –ApiId 0123456789 –SpecificationFormat 'Wadl' –SaveAs 'C:\contoso\specifications\0123456789.wadl'</dev:code> <dev:remarks> <maml:para>Export API to file as WADL.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmApiManagementApi</command:name> <maml:description> <maml:para>Gets a list or a particular API description.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureApiManagementApi</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Gets a list or a particular API description.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmApiManagementApi</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmApiManagementApi</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>API identifier to look for. If specified will try to get the API by the Id. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmApiManagementApi</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the API. If specified will try to get the API by name. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmApiManagementApi</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>If specified will try to get all Product APIs. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>API identifier to look for. If specified will try to get the API by the Id. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of the API. If specified will try to get the API by 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>If specified will try to get all Product APIs. 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> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>IList<Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi></maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi</maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmApiManagementApi –Context $apimContext</dev:code> <dev:remarks> <maml:para>Get list of all APIs.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmApiManagementApi –Context $apimContext –ApiId $apiId</dev:code> <dev:remarks> <maml:para>Get API by Id.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmApiManagementApi –Context $apimContext –Name "EchoApi"</dev:code> <dev:remarks> <maml:para>Get API by Name</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmApiManagementAuthorizationServer</command:name> <maml:description> <maml:para>Gets all or specific authorization servers.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureApiManagementAuthorizationServer</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Gets all or specific authorization servers.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmApiManagementAuthorizationServer</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServerId</maml:name> <maml:description> <maml:para>Identifier of the authorization server. If specified will find authorization server by the identifier. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServerId</maml:name> <maml:description> <maml:para>Identifier of the authorization server. If specified will find authorization server 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>IList<Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOAuth2AuthrozationServer></maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOAuth2AuthrozationServer</maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmApiManagementAuthrizarionServer –Context $apimContext</dev:code> <dev:remarks> <maml:para>Get all authorization servers.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmApiManagementCertificate –Context $apimContext –ServerId 0123456789</dev:code> <dev:remarks> <maml:para>Get specific authorization server.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmApiManagementCertificate</command:name> <maml:description> <maml:para>Gets all or specific certificates.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureApiManagementCertificate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Gets all or specific certificates.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmApiManagementCertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmApiManagementCertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>CertificateId</maml:name> <maml:description> <maml:para>Identifier of the certificate. If specified will find certificate by the identifier. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>CertificateId</maml:name> <maml:description> <maml:para>Identifier of the certificate. If specified will find certificate by the identifier. 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> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </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> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmApiManagementCertificate –Context $apimContext</dev:code> <dev:remarks> <maml:para>Get all certificates.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmApiManagementCertificate –Context $apimContext –CertificateId 0123456789</dev:code> <dev:remarks> <maml:para>Get specific certificate.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmApiManagementGroup</command:name> <maml:description> <maml:para>Gets all or specific groups.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureApiManagementGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Gets all or specific groups.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmApiManagementGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Group name. If specified will try to find group by the name. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmApiManagementGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Identifier of a group. If specified will try to find group by the identifier. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Group name. If specified will try to find group by the name. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmApiManagementGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Group name. If specified will try to find group by the name. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Identifier of existing user. If specified will return all groups the user belongs to. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmApiManagementGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Group name. If specified will try to find group by the name. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Group name. If specified will try to find group by the 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Identifier of a group. If specified will try to find group 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Identifier of existing user. If specified will return all groups the user belongs 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>IList<Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGroup></maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGroup</maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmApiManagementGroup –Context $apimContext</dev:code> <dev:remarks> <maml:para>Get all groups.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmApiManagementGroup –Context $apimContext –GroupId 0123456789</dev:code> <dev:remarks> <maml:para>Get group by identifier.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmApiManagementGroup –Context $apimContext –Name 'Custom group'</dev:code> <dev:remarks> <maml:para>Get group by name.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmApiManagementGroup –Context $apimContext –UserId 0123456789</dev:code> <dev:remarks> <maml:para>Get all user groups.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmApiManagementOperation</command:name> <maml:description> <maml:para>Gets a list or a particular API Operation.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureApiManagementOperation</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Gets a list or a particular API Operation.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmApiManagementOperation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier of API Operation belongs to. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmApiManagementOperation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier of API Operation belongs to. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>OperationId</maml:name> <maml:description> <maml:para>Identifier operation to look for. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier of API Operation belongs to. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>OperationId</maml:name> <maml:description> <maml:para>Identifier operation to look for. 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> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>IList<Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOperation></maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOperation</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmApiManagementOperation –Context $apimContext –ApiId $apiId</dev:code> <dev:remarks> <maml:para>Get all API Operations.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmApiManagementOperation –Context $apimContext –ApiId $apiId –OperationId 0123456789</dev:code> <dev:remarks> <maml:para>Get Operation by id.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmApiManagementPolicy</command:name> <maml:description> <maml:para>Gets specified scope policy.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureApiManagementPolicy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Gets specified scope policy.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmApiManagementPolicy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Format</maml:name> <maml:description> <maml:para>Format of the policy. This parameter is optional. Default value is ‘application/vnd.ms-azure-apim.policy+xml’.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SaveAs</maml:name> <maml:description> <maml:para>File path to save the result to. If not specified the result will be sent to pipeline as a sting. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Identifier of existing operation. If specified with ApiId will return operation-scope policy. This parameters is optional.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmApiManagementPolicy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Format</maml:name> <maml:description> <maml:para>Format of the policy. This parameter is optional. Default value is ‘application/vnd.ms-azure-apim.policy+xml’.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SaveAs</maml:name> <maml:description> <maml:para>File path to save the result to. If not specified the result will be sent to pipeline as a sting. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Identifier of existing product. If specified will return product-scope policy. This parameters is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Identifier of existing operation. If specified with ApiId will return operation-scope policy. This parameters is optional.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmApiManagementPolicy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Format</maml:name> <maml:description> <maml:para>Format of the policy. This parameter is optional. Default value is ‘application/vnd.ms-azure-apim.policy+xml’.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SaveAs</maml:name> <maml:description> <maml:para>File path to save the result to. If not specified the result will be sent to pipeline as a sting. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier of existing API. If specified will return API-scope policy. This parameters is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>OperationId</maml:name> <maml:description> <maml:para>Identifier of existing operation. If specified with ApiId will return operation-scope policy. This parameters is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Identifier of existing operation. If specified with ApiId will return operation-scope policy. This parameters is optional.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmApiManagementPolicy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Format</maml:name> <maml:description> <maml:para>Format of the policy. This parameter is optional. Default value is ‘application/vnd.ms-azure-apim.policy+xml’.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SaveAs</maml:name> <maml:description> <maml:para>File path to save the result to. If not specified the result will be sent to pipeline as a sting. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier of existing API. If specified will return API-scope policy. This parameters is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Identifier of existing operation. If specified with ApiId will return operation-scope policy. This parameters is optional.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Format</maml:name> <maml:description> <maml:para>Format of the policy. This parameter is optional. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SaveAs</maml:name> <maml:description> <maml:para>File path to save the result to. If not specified the result will be sent to pipeline as a sting. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Identifier of existing operation. If specified with ApiId will return operation-scope policy. This parameters 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Identifier of existing product. If specified will return product-scope policy. This parameters 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier of existing API. If specified will return API-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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>OperationId</maml:name> <maml:description> <maml:para>Identifier of existing operation. If specified with ApiId will return 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> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>string</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>bool</maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmApiManagementPolicy –Context $apimContext –SaveAs 'C:\contoso\policies\tenantpolicy.xml'</dev:code> <dev:remarks> <maml:para>Get tenant level policy and save to file named tenantpolicy.xml.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$policyString = Get-AzureRmApiManagementPolicy –Context $apimContext –ProductId 0123456789</dev:code> <dev:remarks> <maml:para>Get product-scope policy</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$policyString = Get-AzureRmApiManagementPolicy –Context $apimContext –ApiId 9876543210</dev:code> <dev:remarks> <maml:para>Get API-scope policy.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmApiManagementPolicy –Context $apimContext –ApiId 9876543210 –OperationId 777</dev:code> <dev:remarks> <maml:para>Get operation-scope policy.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmApiManagementProduct</command:name> <maml:description> <maml:para>Gets a list or a particular Product.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureApiManagementProduct</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>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="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmApiManagementProduct</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Identifier of Product to search for. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmApiManagementProduct</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Title of the Product to look for. If specified will try to get the Product by title. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Identifier of Product to search for. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Title of the Product to look for. If specified will try to get the Product by 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> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>IList<Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProduct></maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProduct</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmApiManagementProduct –Context $apimContext</dev:code> <dev:remarks> <maml:para>Get all Products.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmApiManagementProduct –Context $apimContext –ProductId 0123456789</dev:code> <dev:remarks> <maml:para>Get Product by id.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmApiManagementSubscription</command:name> <maml:description> <maml:para>Gets all or specific subscriptions.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureApiManagementSubscription</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Gets all or specific subscriptions.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmApiManagementSubscription</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmApiManagementSubscription</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>Subscription identifier. If specified will try to find subscription by the identifier. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmApiManagementSubscription</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>User identifier. If specified will try to find all subscriptions by the user identifier. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmApiManagementSubscription</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Product identifier. If specified will try to find all subscriptions by the product identifier. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>Subscription identifier. If specified will try to find subscription 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>User identifier. If specified will try to find all subscriptions by the user 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Product identifier. If specified will try to find all subscriptions by the product 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> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>IList<Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscription></maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscription</maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmApiManagementSubscription –Context $apimContext</dev:code> <dev:remarks> <maml:para>Get all subscriptions.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmApiManagementSubscription –Context $apimContext –SubscriptionId 0123456789</dev:code> <dev:remarks> <maml:para>Get subscription by Id.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmApiManagementSubscription –Context $apimContext –UserId 777</dev:code> <dev:remarks> <maml:para>Get all users subscriptions.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmApiManagementSubscription –Context $apimContext –ProductId 999</dev:code> <dev:remarks> <maml:para>Get all subscriptions for the product.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmApiManagementUser</command:name> <maml:description> <maml:para>Gets all or specific user.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureApiManagementUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Gets all or specific user.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmApiManagementUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmApiManagementUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Identifier of a user. If specified will try to find user by the identifier. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Get-AzureRmApiManagementUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para>User first name. If specified will try to find users by the first name. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para>User last name. If specified will try to find users by the last name. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>User state. If specified will try to find all users in the state. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[PsApiManagementUserState]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Email</maml:name> <maml:description> <maml:para>User email. If specified will try to find user by email. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Identifier of existing group. If specified will try to find all users within the group. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Identifier of a user. If specified will try to find user 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para>User first name. If specified will try to find users by the 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para>User last name. If specified will try to find users by the 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>User state. If specified will try to find all users in the state. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[PsApiManagementUserState]</command:parameterValue> <dev:type> <maml:name>Nullable`1[PsApiManagementUserState]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Email</maml:name> <maml:description> <maml:para>User email. If specified will try to find 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Identifier of existing group. If specified will try to find all users within the 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> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>IList<Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUser></maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> <command:returnValue> <dev:type> <maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUser</maml:name> <maml:uri /> <maml:description /> </dev:type> <maml:description> <maml:para /> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmApiManagementUser –Context $apimContext</dev:code> <dev:remarks> <maml:para>Get all users.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmApiManagementUser –Context $apimContext –UserId 0123456789</dev:code> <dev:remarks> <maml:para>Get user by Id.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmApiManagementUser –Context $apimContext –LastName 'Ivanov'</dev:code> <dev:remarks> <maml:para>Get users by last name.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmApiManagementUser –Context $apimContext –Email 'user@contoso.com'</dev:code> <dev:remarks> <maml:para>Get user by email.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 5 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmApiManagementUser –Context $apimContext –GroupId 0001</dev:code> <dev:remarks> <maml:para>Get all users within the group.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Get-AzureRmApiManagementUserSsoUrl</command:name> <maml:description> <maml:para>Generates SSO URL for the user.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Get</command:verb> <command:noun>AzureApiManagementUserSsoUrl</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Generates SSO URL for the user.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-AzureRmApiManagementUserSsoUrl</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Identifier of existing user. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Identifier of existing user. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>string</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmApiManagementUserSsoUrl –Context $apimContext –UserId 0123456789</dev:code> <dev:remarks> <maml:para>Get user SSO URL.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Import-AzureRmApiManagementApi</command:name> <maml:description> <maml:para>Imports API from file or URL in one of the supported formats.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Import</command:verb> <command:noun>AzureApiManagementApi</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Imports API from file or URL in one of the supported formats (Wadl, Swagger).</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Import-AzureRmApiManagementApi</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier for importing API. This parameter is optional. If not specified the identifier will be generated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SpecificationFormat</maml:name> <maml:description> <maml:para>Specification format (Wadl, Swagger). This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PsApiManagementApiFormat</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SpecificationPath</maml:name> <maml:description> <maml:para>Specification file path. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Web API Path. Last part of the API's public URL. This URL will be used by API consumers for sending requests to the web service. Must be 1 to 400 characters long. This parameter is optional. Default value is $null.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Import-AzureRmApiManagementApi</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier for importing API. This parameter is optional. If not specified the identifier will be generated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SpecificationFormat</maml:name> <maml:description> <maml:para>Specification format (Wadl, Swagger). This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PsApiManagementApiFormat</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SpecificationUrl</maml:name> <maml:description> <maml:para>Specification URL. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Web API Path. Last part of the API's public URL. This URL will be used by API consumers for sending requests to the web service. Must be 1 to 400 characters long. This parameter is optional. Default value is $null.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier for importing API. This parameter is optional. If not specified the identifier 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SpecificationFormat</maml:name> <maml:description> <maml:para>Specification format (Wadl, Swagger). This parameter is required.</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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SpecificationPath</maml:name> <maml:description> <maml:para>Specification file path. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Web API Path. Last part of the API's public URL. This URL will be used by API consumers for sending requests to the web service. Must be 1 to 400 characters long. This parameter is optional. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SpecificationUrl</maml:name> <maml:description> <maml:para>Specification URL. 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> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </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> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> Imported API</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Import-AzureRmApiManagementApi –Context $apimContext –SpecificationFormat 'Wadl' –SpecificationPath 'C:\contoso\specifications\echoapi.wadl' –Path 'apis'</dev:code> <dev:remarks> <maml:para>Import API from WADL file.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Import-AzureRmApiManagementApi –Context $apimContext –SpecificationFormat 'Swagger' –SpecificationPath 'C:\contoso\specifications\echoapi.swagger' –Path 'apis'</dev:code> <dev:remarks> <maml:para>Import API from Swagger file.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Import-AzureRmApiManagementApi –Context $apimContext –SpecificationFormat 'Wadl' –SpecificationUrl 'http://contoso.com/specifications/wadl/echoapi' –Path 'apis'</dev:code> <dev:remarks> <maml:para>Import API from WADL link.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureRmApiManagementApi</command:name> <maml:description> <maml:para>Creates new API.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureApiManagementApi</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Creates new API.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmApiManagementApi</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier for new API. This parameter is optional. If not specified the identifier will be generated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Web API name. Public name of the API as it would appear on the developer and admin portals. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Web API description. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServiceUrl</maml:name> <maml:description> <maml:para>A URL of the web service exposing the API. This URL will be used by Azure API Management only, and will not be made public. Must be 1 to 2000 characters long. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Web API Path. Last part of the API's public URL. This URL will be used by API consumers for sending requests to the web service. Must be 1 to 400 characters long. This parameter is optional. Default value is $null.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Protocols</maml:name> <maml:description> <maml:para>Web API protocols (http, https). Protocols over which API is made available. This parameter is required. Default value is $null.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PsApiManagementSchema[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AuthorizationServerId</maml:name> <maml:description> <maml:para>OAuth authorization server identifier. This parameter is optional. Default value is $null. Must be specified if AuthorizationScope specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AuthorizationScope</maml:name> <maml:description> <maml:para>OAuth operations scope. This parameter is optional. Default value is $null.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubscriptionKeyHeaderName</maml:name> <maml:description> <maml:para>Subscription key header name. This parameter is optional. Default value is $null.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubscriptionKeyQueryParamName</maml:name> <maml:description> <maml:para>Subscription key query string parameter name. This parameter is optional. Default value is $null.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductIds</maml:name> <maml:description> <maml:para>Array of products IDs to add the new API to. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier for new API. This parameter is optional. If not specified the identifier 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Web API name. Public name of the API as it would appear on the developer and admin portals. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Web API 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServiceUrl</maml:name> <maml:description> <maml:para>A URL of the web service exposing the API. This URL will be used by Azure API Management only, and will not be made public. Must be 1 to 2000 characters long. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Web API Path. Last part of the API's public URL. This URL will be used by API consumers for sending requests to the web service. Must be 1 to 400 characters long. This parameter is optional. 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>$null</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Protocols</maml:name> <maml:description> <maml:para>Web API protocols (http, https). Protocols over which API is made available. This parameter is required. Default value is $null.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PsApiManagementSchema[]</command:parameterValue> <dev:type> <maml:name>PsApiManagementSchema[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$null</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AuthorizationServerId</maml:name> <maml:description> <maml:para>OAuth authorization server identifier. This parameter is optional. Default value is $null. Must be specified if AuthorizationScope 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>$null</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AuthorizationScope</maml:name> <maml:description> <maml:para>OAuth operations scope. This parameter is optional. 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>$null</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubscriptionKeyHeaderName</maml:name> <maml:description> <maml:para>Subscription key header name. This parameter is optional. 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>$null</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubscriptionKeyQueryParamName</maml:name> <maml:description> <maml:para>Subscription key query string parameter name. This parameter is optional. 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>$null</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductIds</maml:name> <maml:description> <maml:para>Array of products IDs to add the new API to. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>$null</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </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> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>New-AzureRmApiManagementApi –Context $apimContext –Name EchoApi –ServiceUrl 'https://contoso.com/apis/echo' -Protocols @('http', 'https')</dev:code> <dev:remarks> <maml:para>Create new API.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureRmApiManagementAuthorizationServer</command:name> <maml:description> <maml:para>Creates new authorization server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureApiManagementAuthorizationServer</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Creates new authorization server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmApiManagementAuthorizationServer</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServerId</maml:name> <maml:description> <maml:para>Identifier of existing authorization server. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of new authorization server. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of new authorization server. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ClientRegistrationPageUrl</maml:name> <maml:description> <maml:para>Client registration endpoint is used for registering clients with the authorization server and obtaining client credentials. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AuthorizationEndpointUrl</maml:name> <maml:description> <maml:para>Authorization endpoint is used to authenticate resource owners and obtain authorization grants. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TokenEndpointUrl</maml:name> <maml:description> <maml:para>Token endpoint is used by clients to obtain access tokens in exchange for presenting authorization grants or refresh tokens. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ClientId</maml:name> <maml:description> <maml:para>Client ID of developer console which is the client application. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ClientSecret</maml:name> <maml:description> <maml:para>Client secret of developer console which is the client application. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AuthorizationRequestMethods</maml:name> <maml:description> <maml:para>Supported authorization request methods (GET, POST). This parameter is optional. Default value is GET.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PsApiManagementAuthorizationRequestMethod[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>GrantTypes</maml:name> <maml:description> <maml:para>Supported grant types (AuthorizationCode, Implicit, ResourceOwnerPassword, ClientCredentials). This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PsApiManagementGrantType[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ClientAuthenticationMethods</maml:name> <maml:description> <maml:para>Supported client authentication methods (Basic, Body). This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PsApiManagementClientAuthenticationMethod[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TokenBodyParameters</maml:name> <maml:description> <maml:para>Additional body parameters using application/x-www-form-urlencoded format. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SupportState</maml:name> <maml:description> <maml:para>Whether to support state parameter. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Boolean]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DefaultScope</maml:name> <maml:description> <maml:para>Authorization server default scope. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AccessTokenSendingMethods</maml:name> <maml:description> <maml:para>Supported methods of sending access token (AuthorizationHeader, Query). This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PsApiManagementAccessTokenSendingMethod[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ResourceOwnerUsername</maml:name> <maml:description> <maml:para>Resource owner user name. This parameter is required if ‘ResourceOwnerPassword’ is present in -GrantTypes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ResourceOwnerPassword</maml:name> <maml:description> <maml:para>Resource owner password. This parameter is required if ‘ResourceOwnerPassword’ is present in -GrantTypes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServerId</maml:name> <maml:description> <maml:para>Identifier of existing authorization server. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of new authorization server. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of new authorization server. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ClientRegistrationPageUrl</maml:name> <maml:description> <maml:para>Client registration endpoint is used for registering clients with the authorization server and obtaining client credentials. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AuthorizationEndpointUrl</maml:name> <maml:description> <maml:para>Authorization endpoint is used to authenticate resource owners and obtain authorization grants. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TokenEndpointUrl</maml:name> <maml:description> <maml:para>Token endpoint is used by clients to obtain access tokens in exchange for presenting authorization grants or refresh tokens. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ClientId</maml:name> <maml:description> <maml:para>Client ID of developer console which is the client application. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ClientSecret</maml:name> <maml:description> <maml:para>Client secret of developer console which is the client application. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AuthorizationRequestMethods</maml:name> <maml:description> <maml:para>Supported authorization request methods (GET, POST). This parameter is optional. Default value is GET.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PsApiManagementAuthorizationRequestMethod[]</command:parameterValue> <dev:type> <maml:name>PsApiManagementAuthorizationRequestMethod[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>GrantTypes</maml:name> <maml:description> <maml:para>Supported grant types (AuthorizationCode, Implicit, ResourceOwnerPassword, ClientCredentials). This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PsApiManagementGrantType[]</command:parameterValue> <dev:type> <maml:name>PsApiManagementGrantType[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ClientAuthenticationMethods</maml:name> <maml:description> <maml:para>Supported client authentication methods (Basic, Body). This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PsApiManagementClientAuthenticationMethod[]</command:parameterValue> <dev:type> <maml:name>PsApiManagementClientAuthenticationMethod[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TokenBodyParameters</maml:name> <maml:description> <maml:para>Additional body parameters using application/x-www-form-urlencoded format. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SupportState</maml:name> <maml:description> <maml:para>Whether to support state parameter. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DefaultScope</maml:name> <maml:description> <maml:para>Authorization server default scope. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AccessTokenSendingMethods</maml:name> <maml:description> <maml:para>Supported methods of sending access token (AuthorizationHeader, Query). This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PsApiManagementAccessTokenSendingMethod[]</command:parameterValue> <dev:type> <maml:name>PsApiManagementAccessTokenSendingMethod[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ResourceOwnerUsername</maml:name> <maml:description> <maml:para>Resource owner user name. This parameter is required if ‘ResourceOwnerPassword’ is present in -GrantTypes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ResourceOwnerPassword</maml:name> <maml:description> <maml:para>Resource owner password. This parameter is required if ‘ResourceOwnerPassword’ is present in -GrantTypes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </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> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>New-AzureRmApiManagementAuthrizarionServer –Context $apimContext –Name 'Contoso OAuth2 server' –ClientRegistrationPageUrl 'https://contoso/signup' -AthorizationEndpointUrl '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' –ResourveOwnerPassword 'qwerty'</dev:code> <dev:remarks> <maml:para>Create new authorization server.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureRmApiManagementCertificate</command:name> <maml:description> <maml:para>Creates new certificate.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureApiManagementCertificate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Creates new certificate.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmApiManagementCertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>CertificateId</maml:name> <maml:description> <maml:para>Identifier of new certificate. This parameter is optional. If not specified will be generated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PfxFilePath</maml:name> <maml:description> <maml:para>Path to the certificate file in .pfx format to be created/uploaded. This parameter is required if -PfxBytes not specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PfxPassword</maml:name> <maml:description> <maml:para>Password for the certificate. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-AzureRmApiManagementCertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>CertificateId</maml:name> <maml:description> <maml:para>Identifier of new certificate. This parameter is optional. If not specified will be generated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PfxBytes</maml:name> <maml:description> <maml:para>Bytes of the certificate file in .pfx format to be created/uploaded. This parameter is required if -PfxFilePath not specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Byte[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PfxPassword</maml:name> <maml:description> <maml:para>Password for the certificate. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>CertificateId</maml:name> <maml:description> <maml:para>Identifier of new certificate. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PfxFilePath</maml:name> <maml:description> <maml:para>Path to the certificate file in .pfx format to be created/uploaded. This parameter is required if -PfxBytes 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PfxPassword</maml:name> <maml:description> <maml:para>Password for the certificate. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PfxBytes</maml:name> <maml:description> <maml:para>Bytes of the certificate file in .pfx format to be created/uploaded. This parameter is required if -PfxFilePath not specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Byte[]</command:parameterValue> <dev:type> <maml:name>Byte[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </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> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>New-AzureRmApiManagementCertificate –Context $apimContext –PfxFilePath 'C:\contoso\certificates\apimanagement.pfx' –PfxPassword 1111</dev:code> <dev:remarks> <maml:para>Create/upload new certificate.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureRmApiManagementContext</command:name> <maml:description> <maml:para>Create PsAzureApiManagementContext.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureApiManagementContext</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Create an instance of PsAzureApiManagementContext. The context is to be used for all the API Management Service Management cmdlets.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmApiManagementContext</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Name of resource group under which an API Management service is deployed.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Name of deployed API Management service.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ResourceGroupName</maml:name> <maml:description> <maml:para>Name of 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServiceName</maml:name> <maml:description> <maml:para>Name of 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </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> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>$apimContext = New-AzureRmApiManagementContext –ResourceGroupName contosoresources –ServiceName contoso</dev:code> <dev:remarks> <maml:para>Create an instance of PsApiManagementContext</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureRmApiManagementGroup</command:name> <maml:description> <maml:para>Creates new group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureApiManagementGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Creates new group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmApiManagementGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Identifier of new group. This parameter is optional. If not specified will be generated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Group name. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Group description. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Identifier of new group. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Group name. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Group 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </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> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>New-AzureRmApiManagementGroup –Context $apimContext –Name 'Best devs'</dev:code> <dev:remarks> <maml:para>Create new group.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureRmApiManagementOperation</command:name> <maml:description> <maml:para>Create new API Operation.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureApiManagementOperation</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Create new API Operation.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmApiManagementOperation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier of API. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>OperationId</maml:name> <maml:description> <maml:para>Identifier of new operation. This parameter is optional. If not specified will be generated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Display name of new operation. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Method</maml:name> <maml:description> <maml:para>HTTP method of new operation. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UrlTemplate</maml:name> <maml:description> <maml:para>URL template. Example: customers/{cid}/orders/{oid}/?date={date}. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of new operation. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TemplateParameters</maml:name> <maml:description> <maml:para>Array or parameters defined in UrlTemplate. This parameter is optional. If not specified default value will be generated based on the UrlTemplate. Use the parameter to give more details on parameters like description, type, possible values.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PsApiManagementParameter[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Request</maml:name> <maml:description> <maml:para>Operation request details. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PsApiManagementRequest</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Responses</maml:name> <maml:description> <maml:para>Array of possible operation responses. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PsApiManagementResponse[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier of API. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>OperationId</maml:name> <maml:description> <maml:para>Identifier of new operation. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Display name of new operation. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Method</maml:name> <maml:description> <maml:para>HTTP method of new operation. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UrlTemplate</maml:name> <maml:description> <maml:para>URL template. Example: customers/{cid}/orders/{oid}/?date={date}. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of new operation. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TemplateParameters</maml:name> <maml:description> <maml:para>Array or parameters defined in UrlTemplate. This parameter is optional. If not specified default value will be generated based on the UrlTemplate. Use the parameter to give more details on parameters like description, type, possible values.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PsApiManagementParameter[]</command:parameterValue> <dev:type> <maml:name>PsApiManagementParameter[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Request</maml:name> <maml:description> <maml:para>Operation request details. This parameter is optional.</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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Responses</maml:name> <maml:description> <maml:para>Array of possible operation responses. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PsApiManagementResponse[]</command:parameterValue> <dev:type> <maml:name>PsApiManagementResponse[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </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> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>New-AzureRmApiManagementOperation –Context $apimContext –ApiId $apiId –OperationId 01234567890 –Name 'Get resource' –Method 'GET' –UrlTemplate '/resource' –Description 'Use this operation to get resource'</dev:code> <dev:remarks> <maml:para>Create new operation.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>#create parameters declared in UrlTemplate $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' #create request $request = New-Object –TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementRequest $request.Description = 'Create/update resource request' #create query parameters for the request $dummyQp = New-Object –TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementParameter $dummyQp.Name = 'dummy' $dummyQp.Type = 'string' $dummyQp.Required = $FALSE $request.QueryParameters = @($dummyQp) #create headers for the request $header = New-Object –TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementParameter $header.Name = 'x-custom-header' $header.Type = 'string' $request.Headers = @($header) #create request representation $requestRepresentation = New-Object –TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementRepresentation $requestRepresentation.ContentType = 'application/json' $requestRepresentation.Sample = '{ "propName": "propValue" }' $request.Representations = @($requestRepresentation) #create response $response = New-Object –TypeName Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementResponse $response.StatusCode = 204 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>Script to create new operation with request and response details.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureRmApiManagementProduct</command:name> <maml:description> <maml:para>Creates new product.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureApiManagementProduct</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Creates new product.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmApiManagementProduct</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Identifier of new Product. This parameter is optional. If not specified will be generated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Product title. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Product description. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>LegalTerms</maml:name> <maml:description> <maml:para>Legal terms of use of the product. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubscriptionRequired</maml:name> <maml:description> <maml:para>Whether the product requires subscription or not. This parameter is optional. Default value is $true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Boolean]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApprovalRequired</maml:name> <maml:description> <maml:para>Whether subscription to the product requires approval or not. This parameter is optional. Default value is $false.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Boolean]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubscriptionsLimit</maml:name> <maml:description> <maml:para>Maximum number of simultaneous subscriptions. This parameter is optional. Default value is 1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Int32]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SubscriptionPeriod</maml:name> <maml:description> <maml:para>The period user subscriptions stays active once approved. This parameter is optional. Default value is $null. The format is: {period}{value}. Examples: D2 (two days), M6 (six months), Y1(one year).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NotificationPeriod</maml:name> <maml:description> <maml:para>Specifies upcoming subscription expiration notification period. This parameter is optional. Default value is $null. The format is: {period}{value}. Examples: D2 (two days), M6 (six months), Y1(one year).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Product state. One of: NotPublished, Published. This parameter is optional. Default value is NotPublished.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[PsApiManagementProductState]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Identifier of new Product. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Product title. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Product 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>LegalTerms</maml:name> <maml:description> <maml:para>Legal terms of use of the product. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubscriptionRequired</maml:name> <maml:description> <maml:para>Whether the product requires subscription or not. This parameter is optional. Default value is $true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApprovalRequired</maml:name> <maml:description> <maml:para>Whether subscription to the product requires approval or not. This parameter is optional. Default value is $false.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubscriptionsLimit</maml:name> <maml:description> <maml:para>Maximum number of simultaneous subscriptions. This parameter is optional. Default value is 1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Int32]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int32]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>SubscriptionPeriod</maml:name> <maml:description> <maml:para>The period user subscriptions stays active once approved. This parameter is optional. Default value is $null. The format is: {period}{value}. Examples: D2 (two days), M6 (six months), Y1(one year).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>NotificationPeriod</maml:name> <maml:description> <maml:para>Specifies upcoming subscription expiration notification period. This parameter is optional. Default value is $null. The format is: {period}{value}. Examples: D2 (two days), M6 (six months), Y1(one year).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Product state. One of: NotPublished, Published. This parameter is optional. Default value is NotPublished.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[PsApiManagementProductState]</command:parameterValue> <dev:type> <maml:name>Nullable`1[PsApiManagementProductState]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </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> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>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>Crete new product. No subscription required.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>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>Crete new product. Subscription and approval required. Notification period – 10 days. Subscription period – 1 year.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureRmApiManagementSubscription</command:name> <maml:description> <maml:para>Creates new subscription.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureApiManagementSubscription</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Creates new subscription.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmApiManagementSubscription</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>Identifier of new subscription. This parameter is optional. If not specified will be generated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Subscription name. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Identifier of existing user - the subscriber. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Identifier of existing product to subscribe to. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PrimaryKey</maml:name> <maml:description> <maml:para>Subscription primary key. This parameter is optional. If not specified will be generated automatically. Must be 1 to 300 characters long.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SecondaryKey</maml:name> <maml:description> <maml:para>Subscription secondary key. This parameter is optional. If not specified will be generated automatically. Must be 1 to 300 characters long.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Subscription state. This parameter is optional. Default value is $null.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[PsApiManagementSubscriptionState]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>Identifier of new subscription. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Subscription name. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Identifier of existing user - the subscriber. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Identifier of existing product to subscribe to. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PrimaryKey</maml:name> <maml:description> <maml:para>Subscription primary key. This parameter is optional. If not specified will be generated automatically. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SecondaryKey</maml:name> <maml:description> <maml:para>Subscription secondary key. This parameter is optional. If not specified will be generated automatically. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Subscription state. This parameter is optional. Default value is $null.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[PsApiManagementSubscriptionState]</command:parameterValue> <dev:type> <maml:name>Nullable`1[PsApiManagementSubscriptionState]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </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> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>New-AzureRmApiManagementSubscription –Context $apimContext –UserId 777 –ProductId 999</dev:code> <dev:remarks> <maml:para>Subscribe existing user to existing product.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>New-AzureRmApiManagementUser</command:name> <maml:description> <maml:para>Register new user.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>New</command:verb> <command:noun>AzureApiManagementUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Register new user.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-AzureRmApiManagementUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Identifier of new user. This parameter is optional. If not specified will be genetated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para>User first name. This parameter is required. Must be 1 to 100 characters long.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para>User last name. This parameter is required. Must be 1 to 100 characters long.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Email</maml:name> <maml:description> <maml:para>User email. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>User password. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>User state. This parameter is optional. Default value is $null.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[PsApiManagementUserState]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Note</maml:name> <maml:description> <maml:para>Note on the user. This parameter is optional. Default value is $null.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Identifier of new user. This parameter is optional. If not specified will be genetated.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para>User first name. This parameter is required. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para>User last name. This parameter is required. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Email</maml:name> <maml:description> <maml:para>User email. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>User password. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>User state. This parameter is optional. Default value is $null.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[PsApiManagementUserState]</command:parameterValue> <dev:type> <maml:name>Nullable`1[PsApiManagementUserState]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Note</maml:name> <maml:description> <maml:para>Note on the user. This parameter is optional. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </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> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>New-AzureRmApiManagementUser –Context $apimContext –FirstName 'Ivan' –LastName 'Ivanov' –Email 'ivan.ivanov@contoso.com' –Password 'qwerty'</dev:code> <dev:remarks> <maml:para>Register new user.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureRmApiManagementApi</command:name> <maml:description> <maml:para>Remove existing API.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureApiManagementApi</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Remove existing API.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmApiManagementApi</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier of the API. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces delete operation (prevents confirmation dialog). This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If specified will write true in case operation succeeds. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier of the API. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces delete operation (prevents confirmation dialog). 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If specified will write true in case operation succeeds. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>bool</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Remove-AzureRmApiManagementApi –Context $apimContext –ApiId 0123456789</dev:code> <dev:remarks> <maml:para>Remove existing API.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureRmApiManagementApiFromProduct</command:name> <maml:description> <maml:para>Removes existing API from existing Product.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureApiManagementApiFromProduct</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Removes existing API from existing Product.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmApiManagementApiFromProduct</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Identifier of existing Product to remove API from. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier of existing APIs to remove from the product. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Identifier of existing Product to remove API from. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier of existing APIs to remove from the product. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>bool</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Remove-AzureRmApiManagementApiFromProduct –Context $apimContext –ProductId 0123456789 –ApiId 0001 –PassThru</dev:code> <dev:remarks> <maml:para>Remove existing API from an existing Product.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureRmApiManagementAuthorizationServer</command:name> <maml:description> <maml:para>Deletes existing authorization server.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureApiManagementAuthorizationServer</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Deletes existing authorization server.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmApiManagementAuthorizationServer</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServerId</maml:name> <maml:description> <maml:para>Identifier of existing authorization server. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces delete operation (prevents confirmation dialog). This parameter is optional. Default value is false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServerId</maml:name> <maml:description> <maml:para>Identifier of existing authorization server. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces delete operation (prevents confirmation dialog). 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>bool</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code> </dev:code> <dev:remarks> <maml:para>Delete existing authorization server.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureRmApiManagementCertificate</command:name> <maml:description> <maml:para>Deletes existing certificate.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureApiManagementCertificate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Deletes existing certificate.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmApiManagementCertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>CertificateId</maml:name> <maml:description> <maml:para>Identifier of existing certificate. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces delete operation (prevents confirmation dialog). This parameter is optional. Default value is false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>CertificateId</maml:name> <maml:description> <maml:para>Identifier of existing certificate. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces delete operation (prevents confirmation dialog). 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>bool</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Remove-AzureRmApiManagementCertificate –Context $apimContext –CertificateId 0123456789 –Force</dev:code> <dev:remarks> <maml:para>Delete existing certificate.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureRmApiManagementGroup</command:name> <maml:description> <maml:para>Deletes existing group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureApiManagementGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Deletes existing group.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmApiManagementGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Identifier of existing group. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces delete operation (prevents confirmation dialog). This parameter is optional. Default value is false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Identifier of existing group. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces delete operation (prevents confirmation dialog). 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>bool</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Remove-AzureRmApiManagementGroup –Context $apimContext –GroupId 0123456789 –Force</dev:code> <dev:remarks> <maml:para>Delete existing group.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureRmApiManagementOperation</command:name> <maml:description> <maml:para>Remove existing operation.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureApiManagementOperation</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Remove existing operation.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmApiManagementOperation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier of API. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>OperationId</maml:name> <maml:description> <maml:para>Identifier of API operation. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces delete operation (prevents confirmation dialog). This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If specified will write true in case operation succeeds. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier of API. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>OperationId</maml:name> <maml:description> <maml:para>Identifier of API operation. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces delete operation (prevents confirmation dialog). 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If specified will write true in case operation succeeds. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>bool</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Remove-AzureRmApiManagementOperation –Context $apimContext –ApiId 0123456789 –OperationId 9876543210 –Force</dev:code> <dev:remarks> <maml:para>Remove existing API Operation.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureRmApiManagementPolicy</command:name> <maml:description> <maml:para>Removes policy from specified scope.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureApiManagementPolicy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Removes policy from specified scope.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmApiManagementPolicy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces delete operation (prevents confirmation dialog). This parameter is optional. Default value is false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureRmApiManagementPolicy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Identifier of existing product. If specified will remove product-scope policy. This parameters is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces delete operation (prevents confirmation dialog). This parameter is optional. Default value is false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureRmApiManagementPolicy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier of existing API. If specified will remove API-scope policy. This parameters is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces delete operation (prevents confirmation dialog). This parameter is optional. Default value is false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Remove-AzureRmApiManagementPolicy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier of existing API. If specified will remove API-scope policy. This parameters is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>OperationId</maml:name> <maml:description> <maml:para>Identifier of existing operation. If specified with ApiId will remove operation-scope policy. This parameters is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces delete operation (prevents confirmation dialog). This parameter is optional. Default value is false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces delete operation (prevents confirmation dialog). 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Identifier of existing product. If specified will remove product-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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier of existing API. If specified will remove API-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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>OperationId</maml:name> <maml:description> <maml:para>Identifier of existing operation. If specified with ApiId will remove 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> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>bool</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Remove-AzureRmApiManagementPolicy –Context $apimContext</dev:code> <dev:remarks> <maml:para>Remove tenant level policy.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Remove-AzureRmApiManagementPolicy –Context $apimContext –ProductId 0123456789</dev:code> <dev:remarks> <maml:para>Remove product-scope policy.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Remove-AzureRmApiManagementPolicy –Context $apimContext –ApiId 9876543210</dev:code> <dev:remarks> <maml:para>Remove API-scope policy.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Remove-AzureRmApiManagementPolicy –Context $apimContext –ApiId 9876543210 –OperationId 777</dev:code> <dev:remarks> <maml:para>Remove operation-scope policy.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureRmApiManagementProduct</command:name> <maml:description> <maml:para>Remove existing product.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureApiManagementProduct</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Remove existing product.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmApiManagementProduct</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Identifier of existing Product. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DeleteSubscriptions</maml:name> <maml:description> <maml:para>Whether to delete subscriptions to the product or not. If not set and subscriptions exists exception will be thrown. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces delete operation (prevents confirmation dialog). This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If specified will write true in case operation succeeds. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Identifier of existing Product. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DeleteSubscriptions</maml:name> <maml:description> <maml:para>Whether to delete subscriptions to the product or not. If not set and subscriptions exists exception will be thrown. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces delete operation (prevents confirmation dialog). 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If specified will write true in case operation succeeds. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>bool</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Remove-AzureRmApiManagementProduct –Context $apimContext –Id 0123456789 -DeleteSubscriptions –Force</dev:code> <dev:remarks> <maml:para>Remove existing Product with all subscriptions.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureRmApiManagementProductFromGroup</command:name> <maml:description> <maml:para>Removes existing product from existing group.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureApiManagementProductFromGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Removes existing product from existing group. In other words removes group assignment from product.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmApiManagementProductFromGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Identifier of existing group. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Identifier of existing product. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Identifier of existing group. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Identifier of existing product. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Remove-AzureRmApiManagementProductFromGroup –Context $apimContext –GroupId 0001 –ProductId 0123456789</dev:code> <dev:remarks> <maml:para>Remove existing product from an existing group.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureRmApiManagementSubscription</command:name> <maml:description> <maml:para>Deletes existing subscription.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureApiManagementSubscription</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Deletes existing subscription.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmApiManagementSubscription</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>Identifier of existing subscription. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces delete operation (prevents confirmation dialog). This parameter is optional. Default value is false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>Identifier of existing subscription. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces delete operation (prevents confirmation dialog). 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>bool</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Remove-AzureRmApiManagementSubscription –Context $apimContext –SubscriptionId 0123456789 -Force</dev:code> <dev:remarks> <maml:para>Delete existing subscription.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureRmApiManagementUser</command:name> <maml:description> <maml:para>Deletes existing user.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureApiManagementUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Deletes existing user.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmApiManagementUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Identifier of existing user. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DeleteSubscriptions</maml:name> <maml:description> <maml:para>Whether to delete subscriptions to the product or not. If not set and subscription exists exception will be thrown. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces delete operation (prevents confirmation dialog). This parameter is optional. Default value is false.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Identifier of existing user. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DeleteSubscriptions</maml:name> <maml:description> <maml:para>Whether to delete subscriptions to the product or not. If not set and subscription exists exception will be thrown. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Force</maml:name> <maml:description> <maml:para>Forces delete operation (prevents confirmation dialog). 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>bool</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Remove-AzureRmApiManagementUser –Context $apimContext –UserId 0123456789 –Force</dev:code> <dev:remarks> <maml:para>Delete existing user.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Remove-AzureRmApiManagementUserFromGroup</command:name> <maml:description> <maml:para>Removes existing user from existing group. </maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Remove</command:verb> <command:noun>AzureApiManagementUserFromGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Removes existing user from existing group. </maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-AzureRmApiManagementUserFromGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Identifier of existing group. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Identifier of existing user. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Identifier of existing group. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Identifier of existing user. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Remove-AzureRmApiManagementUserFromGroup –Context $apimContext –GroupId 0001 –UserId 0123456789</dev:code> <dev:remarks> <maml:para>Remove existing user from an existing group.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureRmApiManagementApi</command:name> <maml:description> <maml:para>Set API details.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureApiManagementApi</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Set API details.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureRmApiManagementApi</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier of existing API. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Web API name. Public name of the API as it would appear on the developer and admin portals. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Web API description. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServiceUrl</maml:name> <maml:description> <maml:para>A URL of the web service exposing the API. This URL will be used by Azure API Management only, and will not be made public. Must be 1 to 2000 characters long. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Web API Path. Last part of the API's public URL. This URL will be used by API consumers for sending requests to the web service. Must be 1 to 400 characters long. This parameter is optional. Default value is $null.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Protocols</maml:name> <maml:description> <maml:para>Web API protocols (http, https). Protocols over which API is made available. This parameter is required. Default value is $null.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PsApiManagementSchema[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AuthorizationServerId</maml:name> <maml:description> <maml:para>OAuth authorization server identifier. This parameter is optional. Default value is $null. Must be specified if AuthorizationScope specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AuthorizationScope</maml:name> <maml:description> <maml:para>OAuth operations scope. This parameter is optional. Default value is $null.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubscriptionKeyHeaderName</maml:name> <maml:description> <maml:para>Subscription key header name. This parameter is optional. Default value is $null.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubscriptionKeyQueryParamName</maml:name> <maml:description> <maml:para>Subscription key query string parameter name. This parameter is optional. Default value is $null.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If specified then instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi type representing the set API.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier of existing API. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Web API name. Public name of the API as it would appear on the developer and admin portals. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Web API 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServiceUrl</maml:name> <maml:description> <maml:para>A URL of the web service exposing the API. This URL will be used by Azure API Management only, and will not be made public. Must be 1 to 2000 characters long. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Path</maml:name> <maml:description> <maml:para>Web API Path. Last part of the API's public URL. This URL will be used by API consumers for sending requests to the web service. Must be 1 to 400 characters long. This parameter is optional. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Protocols</maml:name> <maml:description> <maml:para>Web API protocols (http, https). Protocols over which API is made available. This parameter is required. Default value is $null.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PsApiManagementSchema[]</command:parameterValue> <dev:type> <maml:name>PsApiManagementSchema[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AuthorizationServerId</maml:name> <maml:description> <maml:para>OAuth authorization server identifier. This parameter is optional. Default value is $null. Must be specified if AuthorizationScope 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AuthorizationScope</maml:name> <maml:description> <maml:para>OAuth operations scope. This parameter is optional. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubscriptionKeyHeaderName</maml:name> <maml:description> <maml:para>Subscription key header name. This parameter is optional. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubscriptionKeyQueryParamName</maml:name> <maml:description> <maml:para>Subscription key query string parameter name. This parameter is optional. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If specified then instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi type representing the set API.</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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </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> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-AzureRmApiManagementApi –Context $apimContext –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> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureRmApiManagementAuthorizationServer</command:name> <maml:description> <maml:para>Sets authorization server details.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureApiManagementAuthorizationServer</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Sets authorization server details.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureRmApiManagementAuthorizationServer</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServerId</maml:name> <maml:description> <maml:para>Identifier of existing authorization server. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of new authorization server. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of new authorization server. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ClientRegistrationPageUrl</maml:name> <maml:description> <maml:para>Client registration endpoint is used for registering clients with the authorization server and obtaining client credentials. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AuthorizationEndpointUrl</maml:name> <maml:description> <maml:para>Authorization endpoint is used to authenticate resource owners and obtain authorization grants. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TokenEndpointUrl</maml:name> <maml:description> <maml:para>Token endpoint is used by clients to obtain access tokens in exchange for presenting authorization grants or refresh tokens. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ClientId</maml:name> <maml:description> <maml:para>Client ID of developer console which is the client application. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ClientSecret</maml:name> <maml:description> <maml:para>Client secret of developer console which is the client application. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AuthorizationRequestMethods</maml:name> <maml:description> <maml:para>Supported authorization request methods (GET, POST). This parameter is optional. Default value is GET.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PsApiManagementAuthorizationRequestMethod[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>GrantTypes</maml:name> <maml:description> <maml:para>Supported grant types (AuthorizationCode, Implicit, ResourceOwnerPassword, ClientCredentials). This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PsApiManagementGrantType[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ClientAuthenticationMethods</maml:name> <maml:description> <maml:para>Supported client authentication methods (Basic, Body). This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PsApiManagementClientAuthenticationMethod[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TokenBodyParameters</maml:name> <maml:description> <maml:para>Additional body parameters using application/x-www-form-urlencoded format. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SupportState</maml:name> <maml:description> <maml:para>Whether to support state parameter. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Boolean]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DefaultScope</maml:name> <maml:description> <maml:para>Authorization server default scope. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AccessTokenSendingMethods</maml:name> <maml:description> <maml:para>Supported methods of sending access token (AuthorizationHeader, Query). This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PsApiManagementAccessTokenSendingMethod[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ResourceOwnerUsername</maml:name> <maml:description> <maml:para>Resource owner user name. This parameter is required if ‘ResourceOwnerPassword’ is present in -GrantTypes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ResourceOwnerPassword</maml:name> <maml:description> <maml:para>Resource owner password. This parameter is required if ‘ResourceOwnerPassword’ is present in -GrantTypes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If specified will write Instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOAuth2AuthrozationServer type . This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ServerId</maml:name> <maml:description> <maml:para>Identifier of existing authorization server. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Name of new authorization server. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of new authorization server. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ClientRegistrationPageUrl</maml:name> <maml:description> <maml:para>Client registration endpoint is used for registering clients with the authorization server and obtaining client credentials. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AuthorizationEndpointUrl</maml:name> <maml:description> <maml:para>Authorization endpoint is used to authenticate resource owners and obtain authorization grants. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TokenEndpointUrl</maml:name> <maml:description> <maml:para>Token endpoint is used by clients to obtain access tokens in exchange for presenting authorization grants or refresh tokens. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ClientId</maml:name> <maml:description> <maml:para>Client ID of developer console which is the client application. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ClientSecret</maml:name> <maml:description> <maml:para>Client secret of developer console which is the client application. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AuthorizationRequestMethods</maml:name> <maml:description> <maml:para>Supported authorization request methods (GET, POST). This parameter is optional. Default value is GET.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PsApiManagementAuthorizationRequestMethod[]</command:parameterValue> <dev:type> <maml:name>PsApiManagementAuthorizationRequestMethod[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>GrantTypes</maml:name> <maml:description> <maml:para>Supported grant types (AuthorizationCode, Implicit, ResourceOwnerPassword, ClientCredentials). This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PsApiManagementGrantType[]</command:parameterValue> <dev:type> <maml:name>PsApiManagementGrantType[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ClientAuthenticationMethods</maml:name> <maml:description> <maml:para>Supported client authentication methods (Basic, Body). This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PsApiManagementClientAuthenticationMethod[]</command:parameterValue> <dev:type> <maml:name>PsApiManagementClientAuthenticationMethod[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TokenBodyParameters</maml:name> <maml:description> <maml:para>Additional body parameters using application/x-www-form-urlencoded format. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SupportState</maml:name> <maml:description> <maml:para>Whether to support state parameter. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>DefaultScope</maml:name> <maml:description> <maml:para>Authorization server default scope. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>AccessTokenSendingMethods</maml:name> <maml:description> <maml:para>Supported methods of sending access token (AuthorizationHeader, Query). This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PsApiManagementAccessTokenSendingMethod[]</command:parameterValue> <dev:type> <maml:name>PsApiManagementAccessTokenSendingMethod[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ResourceOwnerUsername</maml:name> <maml:description> <maml:para>Resource owner user name. This parameter is required if ‘ResourceOwnerPassword’ is present in -GrantTypes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ResourceOwnerPassword</maml:name> <maml:description> <maml:para>Resource owner password. This parameter is required if ‘ResourceOwnerPassword’ is present in -GrantTypes.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If specified will write Instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOAuth2AuthrozationServer type . 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </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> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-AzureRmApiManagementAuthrizarionServer –Context $apimContext –ServerId 0123456789 –Name 'Contoso OAuth2 server' –ClientRegistrationPageUrl 'https://contoso/signupv2' -AthorizationEndpointUrl '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>Set authorization server details.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureRmApiManagementCertificate</command:name> <maml:description> <maml:para>Sets certificate data.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureApiManagementCertificate</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Sets certificate data.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureRmApiManagementCertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>CertificateId</maml:name> <maml:description> <maml:para>Identifier of certificate. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PfxFilePath</maml:name> <maml:description> <maml:para>Path to the certificate file in .pfx format to be created/uploaded. This parameter is required if -PfxBytes not specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PfxPassword</maml:name> <maml:description> <maml:para>Password for the certificate. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If specified then instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementCertificate type representing the modified group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureRmApiManagementCertificate</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>CertificateId</maml:name> <maml:description> <maml:para>Identifier of certificate. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PfxBytes</maml:name> <maml:description> <maml:para>Bytes of the certificate file in .pfx format to be created/uploaded. This parameter is required if -PfxFilePath not specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Byte[]</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PfxPassword</maml:name> <maml:description> <maml:para>Password for the certificate. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If specified then instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementCertificate type representing the modified group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>CertificateId</maml:name> <maml:description> <maml:para>Identifier of certificate. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PfxFilePath</maml:name> <maml:description> <maml:para>Path to the certificate file in .pfx format to be created/uploaded. This parameter is required if -PfxBytes 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PfxPassword</maml:name> <maml:description> <maml:para>Password for the certificate. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If specified then instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementCertificate type representing the modified group.</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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PfxBytes</maml:name> <maml:description> <maml:para>Bytes of the certificate file in .pfx format to be created/uploaded. This parameter is required if -PfxFilePath not specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Byte[]</command:parameterValue> <dev:type> <maml:name>Byte[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </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> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-AzureRmApiManagementCertificate –Context $apimContext –CertificateId 0123456789 –PfxFilePath 'C:\contoso\certificates\apimanagementnew.pfx' –PfxPassword 2222</dev:code> <dev:remarks> <maml:para>Set certificate.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureRmApiManagementGroup</command:name> <maml:description> <maml:para>Sets existing group details.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureApiManagementGroup</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Sets existing group details.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureRmApiManagementGroup</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Identifier of existing group. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Group name. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Group description. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If specified then instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGroup type representing the modified group.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>GroupId</maml:name> <maml:description> <maml:para>Identifier of existing group. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Group 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Group 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If specified then instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementGroup type representing the modified group.</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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </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> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>New-AzureRmApiManagementGroup –Context $apimContext –Name 'Best devs'</dev:code> <dev:remarks> <maml:para>Create new group.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureRmApiManagementOperation</command:name> <maml:description> <maml:para>Set API Operation details.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureApiManagementOperation</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Set API Operation details.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureRmApiManagementOperation</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier of API. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>OperationId</maml:name> <maml:description> <maml:para>Identifier of existing operation. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Display name of new operation. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Method</maml:name> <maml:description> <maml:para>HTTP method of new operation. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UrlTemplate</maml:name> <maml:description> <maml:para>URL template. Example: customers/{cid}/orders/{oid}/?date={date}. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of new operation. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TemplateParameters</maml:name> <maml:description> <maml:para>Array or parameters defined in UrlTemplate. This parameter is optional. If not specified default value will be generated based on the UrlTemplate. Use the parameter to give more details on parameters like description, type, possible values.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PsApiManagementParameter[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Request</maml:name> <maml:description> <maml:para>Operation request details. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PsApiManagementRequest</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Responses</maml:name> <maml:description> <maml:para>Array of possible operation responses. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PsApiManagementResponse[]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If specified then instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOperation type representing the modified operation.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier of API. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>OperationId</maml:name> <maml:description> <maml:para>Identifier of existing operation. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Display name of new operation. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Method</maml:name> <maml:description> <maml:para>HTTP method of new operation. 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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UrlTemplate</maml:name> <maml:description> <maml:para>URL template. Example: customers/{cid}/orders/{oid}/?date={date}. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Description of new operation. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>TemplateParameters</maml:name> <maml:description> <maml:para>Array or parameters defined in UrlTemplate. This parameter is optional. If not specified default value will be generated based on the UrlTemplate. Use the parameter to give more details on parameters like description, type, possible values.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PsApiManagementParameter[]</command:parameterValue> <dev:type> <maml:name>PsApiManagementParameter[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Request</maml:name> <maml:description> <maml:para>Operation request details. This parameter is optional.</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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Responses</maml:name> <maml:description> <maml:para>Array of possible operation responses. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">PsApiManagementResponse[]</command:parameterValue> <dev:type> <maml:name>PsApiManagementResponse[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If specified then instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOperation type representing the modified operation.</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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </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> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>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>Set operation details.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureRmApiManagementPolicy</command:name> <maml:description> <maml:para>Set specified scope policy.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureApiManagementPolicy</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Set specified scope policy.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureRmApiManagementPolicy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Format</maml:name> <maml:description> <maml:para>Format of the policy. This parameter is optional. Default value is ‘application/vnd.ms-azure-apim.policy+xml’.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Policy</maml:name> <maml:description> <maml:para>Policy document as a string. This parameter is required if -PolicyFilePath not specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PolicyFilePath</maml:name> <maml:description> <maml:para>Policy document file path. This parameter is required if -Policy not specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureRmApiManagementPolicy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Format</maml:name> <maml:description> <maml:para>Format of the policy. This parameter is optional. Default value is ‘application/vnd.ms-azure-apim.policy+xml’.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Identifier of existing product. If specified will set product-scope policy. This parameters is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Policy</maml:name> <maml:description> <maml:para>Policy document as a string. This parameter is required if -PolicyFilePath not specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PolicyFilePath</maml:name> <maml:description> <maml:para>Policy document file path. This parameter is required if -Policy not specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureRmApiManagementPolicy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Format</maml:name> <maml:description> <maml:para>Format of the policy. This parameter is optional. Default value is ‘application/vnd.ms-azure-apim.policy+xml’.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier of existing API. If specified will set API-scope policy. This parameters is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Policy</maml:name> <maml:description> <maml:para>Policy document as a string. This parameter is required if -PolicyFilePath not specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PolicyFilePath</maml:name> <maml:description> <maml:para>Policy document file path. This parameter is required if -Policy not specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>Set-AzureRmApiManagementPolicy</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Format</maml:name> <maml:description> <maml:para>Format of the policy. This parameter is optional. Default value is ‘application/vnd.ms-azure-apim.policy+xml’.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier of existing API. If specified will set API-scope policy. This parameters is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>OperationId</maml:name> <maml:description> <maml:para>Identifier of 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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Policy</maml:name> <maml:description> <maml:para>Policy document as a string. This parameter is required if -PolicyFilePath not specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PolicyFilePath</maml:name> <maml:description> <maml:para>Policy document file path. This parameter is required if -Policy not specified.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Format</maml:name> <maml:description> <maml:para>Format of the policy. This parameter is optional. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Policy</maml:name> <maml:description> <maml:para>Policy document as a string. This parameter is required if -PolicyFilePath 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PolicyFilePath</maml:name> <maml:description> <maml:para>Policy document file path. This parameter is required if -Policy 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Identifier of existing product. If specified will set product-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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApiId</maml:name> <maml:description> <maml:para>Identifier of existing API. If specified will set API-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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>OperationId</maml:name> <maml:description> <maml:para>Identifier of 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> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>bool</maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-AzureRmApiManagementPolicy –Context $apimContext –PolicyFilePath 'C:\contoso\policies\tenantpolicy.xml'</dev:code> <dev:remarks> <maml:para>Set tenant level policy from file named tenantpolicy.xml.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-AzureRmApiManagementPolicy –Context $apimContext –ProductId 0123456789 –Policy $policystring</dev:code> <dev:remarks> <maml:para>Set product-scope policy.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Get-AzureRmApiManagementPolicy –Context $apimContext –ApiId 9876543210 –Policy $policystring</dev:code> <dev:remarks> <maml:para>Set API-scope policy.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------------------- Example 4 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-AzureRmApiManagementPolicy –Context $apimContext –ApiId 9876543210 –OperationId 777 –Policy $policystring</dev:code> <dev:remarks> <maml:para>Set operation-scope policy.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureRmApiManagementProduct</command:name> <maml:description> <maml:para>Sets Product details.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureApiManagementProduct</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Sets Product details.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureRmApiManagementProduct</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Identifier of existing Product. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Product title. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Product description. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>LegalTerms</maml:name> <maml:description> <maml:para>Legal terms of use of the product. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubscriptionRequired</maml:name> <maml:description> <maml:para>Whether the product requires subscription or not. This parameter is optional. Default value is $true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Boolean]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApprovalRequired</maml:name> <maml:description> <maml:para>Whether subscription to the product requires approval or not. This parameter is optional. Default value is $false.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Boolean]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubscriptionsLimit</maml:name> <maml:description> <maml:para>Maximum number of simultaneous subscriptions. This parameter is optional. Default value is 1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Int32]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubscriptionPeriod</maml:name> <maml:description> <maml:para>The period user subscriptions stays active once approved. This parameter is optional. Default value is $null. The format is: {period}{value}. Examples: D2 (two days), M6 (six months), Y1(one year).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NotificationPeriod</maml:name> <maml:description> <maml:para>Specifies upcoming subscription expiration notification period. This parameter is optional. Default value is $null. The format is: {period}{value}. Examples: D2 (two days), M6 (six months), Y1(one year).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Product state. One of: NotPublished, Published. This parameter is optional. Default value is NotPublished.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[PsApiManagementProductState]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If specified then instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProduct type representing the modified product.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ProductId</maml:name> <maml:description> <maml:para>Identifier of existing Product. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Title</maml:name> <maml:description> <maml:para>Product title. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Description</maml:name> <maml:description> <maml:para>Product 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>LegalTerms</maml:name> <maml:description> <maml:para>Legal terms of use of the product. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubscriptionRequired</maml:name> <maml:description> <maml:para>Whether the product requires subscription or not. This parameter is optional. Default value is $true.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ApprovalRequired</maml:name> <maml:description> <maml:para>Whether subscription to the product requires approval or not. This parameter is optional. Default value is $false.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Boolean]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Boolean]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubscriptionsLimit</maml:name> <maml:description> <maml:para>Maximum number of simultaneous subscriptions. This parameter is optional. Default value is 1.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[Int32]</command:parameterValue> <dev:type> <maml:name>Nullable`1[Int32]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubscriptionPeriod</maml:name> <maml:description> <maml:para>The period user subscriptions stays active once approved. This parameter is optional. Default value is $null. The format is: {period}{value}. Examples: D2 (two days), M6 (six months), Y1(one year).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>NotificationPeriod</maml:name> <maml:description> <maml:para>Specifies upcoming subscription expiration notification period. This parameter is optional. Default value is $null. The format is: {period}{value}. Examples: D2 (two days), M6 (six months), Y1(one year).</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Product state. One of: NotPublished, Published. This parameter is optional. Default value is NotPublished.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[PsApiManagementProductState]</command:parameterValue> <dev:type> <maml:name>Nullable`1[PsApiManagementProductState]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If specified then instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementProduct type representing the modified product.</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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </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> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>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>Update product details: require subscription, unpublish.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureRmApiManagementSubscription</command:name> <maml:description> <maml:para>Sets existing subscription details.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureApiManagementSubscription</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Sets existing subscription details.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureRmApiManagementSubscription</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>Identifier of existing subscription. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Subscription name. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PrimaryKey</maml:name> <maml:description> <maml:para>Subscription primary key. This parameter is optional. If not specified will be generated automatically. Must be 1 to 300 characters long.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SecondaryKey</maml:name> <maml:description> <maml:para>Subscription secondary key. This parameter is optional. If not specified will be generated automatically. Must be 1 to 300 characters long.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Subscription state. This parameter is optional. Default value is $null.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[PsApiManagementSubscriptionState]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ExpiresOn</maml:name> <maml:description> <maml:para>Subscription expiration date. This parameter is optional. Default value is $null.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[DateTime]</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>StateComment</maml:name> <maml:description> <maml:para>Subscription state comment. This parameter is optional. Default value is $null.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If specified then instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscripition type representing the modified subscription.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SubscriptionId</maml:name> <maml:description> <maml:para>Identifier of existing subscription. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Name</maml:name> <maml:description> <maml:para>Subscription 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PrimaryKey</maml:name> <maml:description> <maml:para>Subscription primary key. This parameter is optional. If not specified will be generated automatically. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>SecondaryKey</maml:name> <maml:description> <maml:para>Subscription secondary key. This parameter is optional. If not specified will be generated automatically. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>Subscription state. This parameter is optional. Default value is $null.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[PsApiManagementSubscriptionState]</command:parameterValue> <dev:type> <maml:name>Nullable`1[PsApiManagementSubscriptionState]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>ExpiresOn</maml:name> <maml:description> <maml:para>Subscription expiration date. This parameter is optional. Default value is $null.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="true">Nullable`1[DateTime]</command:parameterValue> <dev:type> <maml:name>Nullable`1[DateTime]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>StateComment</maml:name> <maml:description> <maml:para>Subscription state comment. This parameter is optional. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If specified then instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementSubscripition type representing the modified subscription.</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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </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> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-AzureRmApiManagementSubscription –Context $apimContext –SubscriptionId 0123456789 –PrimaryKey '80450f7d0b6d481382113073f67822c1' –SencondaryKey '97d6112c3a8f48d5bf0266b7a09a761c' –State 'Active'</dev:code> <dev:remarks> <maml:para>Set subscription primary, secondary key and activate.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml: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"> <!--Generated by PS Cmdlet Help Editor--> <command:details> <command:name>Set-AzureRmApiManagementUser</command:name> <maml:description> <maml:para>Sets user details.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Set</command:verb> <command:noun>AzureApiManagementUser</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Sets user details.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-AzureRmApiManagementUser</maml:name> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Identifier of existing user. This parameter is required.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para>User first name. This parameter is optional. Must be 1 to 100 characters long.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para>User last name. This parameter is optional. Must be 1 to 100 characters long.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Email</maml:name> <maml:description> <maml:para>User email. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>User password. This parameter is optional.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>User state. This parameter is optional. Default value is Active.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">PsApiManagementUserState</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Note</maml:name> <maml:description> <maml:para>Note on the user. This parameter is optional. Default value is $null.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If specified then instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUser type representing the modified user.</maml:para> </maml:description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <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> </dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>UserId</maml:name> <maml:description> <maml:para>Identifier of existing user. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>FirstName</maml:name> <maml:description> <maml:para>User first name. This parameter is optional. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>LastName</maml:name> <maml:description> <maml:para>User last name. This parameter is optional. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Email</maml:name> <maml:description> <maml:para>User 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Password</maml:name> <maml:description> <maml:para>User password. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>State</maml:name> <maml:description> <maml:para>User state. This parameter is optional. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>Note</maml:name> <maml:description> <maml:para>Note on the user. This parameter is optional. 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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named"> <maml:name>PassThru</maml:name> <maml:description> <maml:para>If specified then instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementUser type representing the modified user.</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> </dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named"> <maml:name>Profile</maml:name> <maml:description> <maml:para>In-memory profile.</maml:para> </maml:description> <command:parameterValue required="true" variableLength="false">AzureProfile</command:parameterValue> <dev:type> <maml:name>AzureProfile</maml:name> <maml:uri /> </dev:type> <dev:defaultValue> </dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name> </maml:name> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </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> <maml:uri> </maml:uri> <maml:description /> </dev:type> <maml:description> <maml:para> </maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors> </command:terminatingErrors> <command:nonTerminatingErrors> </command:nonTerminatingErrors> <maml:alertSet> <maml:title> </maml:title> <maml:alert> <maml:para /> <maml:para>Keywords: azure, azurerm, arm, resource, management, manager, api, apimanagement, apimgmt, apism</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <maml:introduction> <maml:paragraph>PS C:\></maml:paragraph> </maml:introduction> <dev:code>Set-AzureRmApiManagementUser –Context $apimContext -UserId 0123456789 –Email 'ivanov.ivan@contoso.com' –Password 'asdfgh' –State 'Blocked'</dev:code> <dev:remarks> <maml:para>Set new user password and email and block the user.</maml:para> <maml:para /> <maml:para /> <maml:para> </maml:para> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText> <maml:para /> </command:commandText> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> </maml:relatedLinks> </command:command> </helpItems> |