Skip to content

Commit 6a396e1

Browse files
solankisamirsolankisamir
committed
Updated docs for Deprecated Cmdlet Set-AzureRmApiManagementTenantGitAccess.
Fix Example.
1 parent 17b5e42 commit 6a396e1

File tree

2 files changed

+3
-266
lines changed

2 files changed

+3
-266
lines changed

‎src/ResourceManager/ApiManagement/Commands.ApiManagement.ServiceManagement/Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-help.Help.pshproj

Lines changed: 1 addition & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -1814,7 +1814,7 @@ Imported API</ReturnTypeDescription>
18141814
<Examples>
18151815
<Example>
18161816
<Name>Example 1</Name>
1817-
<Cmd>New-AzureRmApiManagementApi –Context $apimContext –Name EchoApi –ServiceUrl 'https://contoso.com/apis/echo' -Protocols @('http', 'https') -Path 'echoapi'</Cmd>
1817+
<Cmd>New-AzureRmApiManagementApi –Context $apimContext –Name EchoApi –ServiceUrl 'https://contoso.com/apis/echo' -Protocols @("http", "https") -Path 'echoapi'</Cmd>
18181818
<Description>Create new API.</Description>
18191819
<Output />
18201820
</Example>
@@ -7233,93 +7233,6 @@ OpenId Connect Provider.</Description>
72337233
<SupportInformation ad="false" rsat="false" ps2="false" ps3="false" ps4="false" ps5="false" wxp="false" wv="false" w7="false" w8="false" w81="false" w2k3s="false" w2k3e="false" w2k3d="false" w2k8s="false" w2k8e="false" w2k8d="false" w2k8r2s="false" w2k8r2e="false" w2k8r2d="false" w2k12s="false" w2k12d="false" w2k12r2s="false" w2k12r2d="false" />
72347234
<Publish>false</Publish>
72357235
</CmdletObject>
7236-
<CmdletObject verb="Set" noun="AzureRmApiManagementTenantGitAccess">
7237-
<Name>Set-AzureRmApiManagementTenantGitAccess</Name>
7238-
<GeneralHelp>
7239-
<Synopsis>Sets the Git access configuration of the Tenant.</Synopsis>
7240-
<Description>Sets the Git access configuration of the Tenant.</Description>
7241-
<Notes />
7242-
<InputType />
7243-
<InputUrl />
7244-
<InputTypeDescription />
7245-
<ReturnType>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAccessInformation</ReturnType>
7246-
<ReturnUrl />
7247-
<ReturnTypeDescription />
7248-
</GeneralHelp>
7249-
<ParamSets>
7250-
<CommandParameterSetInfo2 Name="__AllParameterSets" Params="Context Enabled PassThru Verbose Debug ErrorAction WarningAction InformationAction ErrorVariable WarningVariable InformationVariable OutVariable OutBuffer PipelineVariable" />
7251-
</ParamSets>
7252-
<Syntax>
7253-
<string>Set-AzureRmApiManagementTenantGitAccess -Context &lt;PsApiManagementContext&gt; -Enabled &lt;Boolean&gt; [-PassThru] [-InformationAction &lt;ActionPreference&gt;] [-InformationVariable &lt;String&gt;]</string>
7254-
</Syntax>
7255-
<Parameters>
7256-
<ParameterDescription type="PsApiManagementContext" varLen="false" required="true" dynamic="false" pipeRemaining="false" pipe="false" pipeProp="true" isPos="false" pos="named" globbing="false">
7257-
<Name>Context</Name>
7258-
<Attributes>
7259-
<string>System.Management.Automation.ParameterAttribute</string>
7260-
<string>System.Management.Automation.ValidateNotNullOrEmptyAttribute</string>
7261-
</Attributes>
7262-
<Aliases />
7263-
<Description>Instance of PsApiManagementContext. This parameter is required.</Description>
7264-
<DefaultValue />
7265-
</ParameterDescription>
7266-
<ParameterDescription type="Boolean" varLen="false" required="true" dynamic="false" pipeRemaining="false" pipe="false" pipeProp="false" isPos="false" pos="named" globbing="false">
7267-
<Name>Enabled</Name>
7268-
<Attributes>
7269-
<string>System.Management.Automation.ParameterAttribute</string>
7270-
<string>System.Management.Automation.ValidateNotNullOrEmptyAttribute</string>
7271-
</Attributes>
7272-
<Aliases />
7273-
<Description>Enable Git access. Set to true for enabling and false for disabling. This parameter is required.</Description>
7274-
<DefaultValue />
7275-
</ParameterDescription>
7276-
<ParameterDescription type="SwitchParameter" varLen="false" required="false" dynamic="false" pipeRemaining="false" pipe="false" pipeProp="true" isPos="false" pos="named" globbing="false">
7277-
<Name>PassThru</Name>
7278-
<Attributes>
7279-
<string>System.Management.Automation.ParameterAttribute</string>
7280-
</Attributes>
7281-
<Aliases />
7282-
<Description>If specified then instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAccessInformation type is returned.</Description>
7283-
<DefaultValue />
7284-
</ParameterDescription>
7285-
<ParameterDescription type="ActionPreference" varLen="false" required="false" dynamic="false" pipeRemaining="false" pipe="false" pipeProp="false" isPos="false" pos="named" globbing="false">
7286-
<Name>InformationAction</Name>
7287-
<Attributes>
7288-
<string>System.Management.Automation.ParameterAttribute</string>
7289-
<string>System.Management.Automation.AliasAttribute</string>
7290-
</Attributes>
7291-
<Aliases>
7292-
<string>infa</string>
7293-
</Aliases>
7294-
<Description />
7295-
<DefaultValue />
7296-
</ParameterDescription>
7297-
<ParameterDescription type="String" varLen="false" required="false" dynamic="false" pipeRemaining="false" pipe="false" pipeProp="false" isPos="false" pos="named" globbing="false">
7298-
<Name>InformationVariable</Name>
7299-
<Attributes>
7300-
<string>System.Management.Automation.ParameterAttribute</string>
7301-
<string>System.Management.Automation.AliasAttribute</string>
7302-
<string>System.Management.Automation.Internal.CommonParameters+ValidateVariableName</string>
7303-
</Attributes>
7304-
<Aliases>
7305-
<string>iv</string>
7306-
</Aliases>
7307-
<Description />
7308-
<DefaultValue />
7309-
</ParameterDescription>
7310-
</Parameters>
7311-
<Examples>
7312-
<Example>
7313-
<Name>Example 1</Name>
7314-
<Cmd>Set-AzureRmApiManagementTenantGitAccess -Context $apimContext -Enabled $true</Cmd>
7315-
<Description>Sets the Git access configuration to True.</Description>
7316-
<Output />
7317-
</Example>
7318-
</Examples>
7319-
<RelatedLinks />
7320-
<SupportInformation ad="false" rsat="false" ps2="false" ps3="false" ps4="false" ps5="false" wxp="false" wv="false" w7="false" w8="false" w81="false" w2k3s="false" w2k3e="false" w2k3d="false" w2k8s="false" w2k8e="false" w2k8d="false" w2k8r2s="false" w2k8r2e="false" w2k8r2d="false" w2k12s="false" w2k12d="false" w2k12r2s="false" w2k12r2d="false" />
7321-
<Publish>false</Publish>
7322-
</CmdletObject>
73237236
<CmdletObject verb="Get" noun="AzureRmApiManagementTenantAccess">
73247237
<Name>Get-AzureRmApiManagementTenantAccess</Name>
73257238
<GeneralHelp>

‎src/ResourceManager/ApiManagement/Commands.ApiManagement.ServiceManagement/Microsoft.Azure.Commands.ApiManagement.ServiceManagement.dll-help.xml

Lines changed: 2 additions & 178 deletions
Original file line numberDiff line numberDiff line change
@@ -4463,7 +4463,7 @@ Imported API</maml:para>
44634463
<maml:introduction>
44644464
<maml:paragraph>PS C:\&gt;</maml:paragraph>
44654465
</maml:introduction>
4466-
<dev:code>New-AzureRmApiManagementApi –Context $apimContext –Name EchoApi –ServiceUrl &apos;https://contoso.com/apis/echo&apos; -Protocols @(&apos;http&apos;, &apos;https&apos;) -Path &apos;echoapi&apos;</dev:code>
4466+
<dev:code>New-AzureRmApiManagementApi –Context $apimContext –Name EchoApi –ServiceUrl &apos;https://contoso.com/apis/echo&apos; -Protocols @(&quot;http&quot;, &quot;https&quot;) -Path &apos;echoapi&apos;</dev:code>
44674467
<dev:remarks>
44684468
<maml:para>Create new API.</maml:para>
44694469
<maml:para />
@@ -16056,182 +16056,6 @@ OpenId Connect Provider.</maml:para>
1605616056
</maml:relatedLinks>
1605716057
</command:command>
1605816058
<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">
16059-
<!--Generated by PS Cmdlet Help Editor-->
16060-
<command:details>
16061-
<command:name>Set-AzureRmApiManagementTenantGitAccess</command:name>
16062-
<maml:description>
16063-
<maml:para>Sets the Git access configuration of the Tenant.</maml:para>
16064-
</maml:description>
16065-
<maml:copyright>
16066-
<maml:para />
16067-
</maml:copyright>
16068-
<command:verb>Set</command:verb>
16069-
<command:noun>AzureRmApiManagementTenantGitAccess</command:noun>
16070-
<dev:version />
16071-
</command:details>
16072-
<maml:description>
16073-
<maml:para>Sets the Git access configuration of the Tenant.</maml:para>
16074-
</maml:description>
16075-
<command:syntax>
16076-
<command:syntaxItem>
16077-
<maml:name>Set-AzureRmApiManagementTenantGitAccess</maml:name>
16078-
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
16079-
<maml:name>Context</maml:name>
16080-
<maml:description>
16081-
<maml:para>Instance of PsApiManagementContext. This parameter is required.</maml:para>
16082-
</maml:description>
16083-
<command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue>
16084-
</command:parameter>
16085-
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
16086-
<maml:name>Enabled</maml:name>
16087-
<maml:description>
16088-
<maml:para>Enable Git access. Set to true for enabling and false for disabling. This parameter is required.</maml:para>
16089-
</maml:description>
16090-
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
16091-
</command:parameter>
16092-
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
16093-
<maml:name>PassThru</maml:name>
16094-
<maml:description>
16095-
<maml:para>If specified then instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAccessInformation type is returned.</maml:para>
16096-
</maml:description>
16097-
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
16098-
</command:parameter>
16099-
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
16100-
<maml:name>InformationAction</maml:name>
16101-
<maml:description>
16102-
<maml:para />
16103-
</maml:description>
16104-
<command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue>
16105-
</command:parameter>
16106-
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
16107-
<maml:name>InformationVariable</maml:name>
16108-
<maml:description>
16109-
<maml:para />
16110-
</maml:description>
16111-
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
16112-
</command:parameter>
16113-
</command:syntaxItem>
16114-
</command:syntax>
16115-
<command:parameters>
16116-
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
16117-
<maml:name>Context</maml:name>
16118-
<maml:description>
16119-
<maml:para>Instance of PsApiManagementContext. This parameter is required.</maml:para>
16120-
</maml:description>
16121-
<command:parameterValue required="true" variableLength="false">PsApiManagementContext</command:parameterValue>
16122-
<dev:type>
16123-
<maml:name>PsApiManagementContext</maml:name>
16124-
<maml:uri/>
16125-
</dev:type>
16126-
<dev:defaultValue></dev:defaultValue>
16127-
</command:parameter>
16128-
<command:parameter required="true" variableLength="false" globbing="false" pipelineInput="false" position="named">
16129-
<maml:name>Enabled</maml:name>
16130-
<maml:description>
16131-
<maml:para>Enable Git access. Set to true for enabling and false for disabling. This parameter is required.</maml:para>
16132-
</maml:description>
16133-
<command:parameterValue required="false" variableLength="false">Boolean</command:parameterValue>
16134-
<dev:type>
16135-
<maml:name>Boolean</maml:name>
16136-
<maml:uri/>
16137-
</dev:type>
16138-
<dev:defaultValue></dev:defaultValue>
16139-
</command:parameter>
16140-
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="true (ByPropertyName)" position="named">
16141-
<maml:name>PassThru</maml:name>
16142-
<maml:description>
16143-
<maml:para>If specified then instance of Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAccessInformation type is returned.</maml:para>
16144-
</maml:description>
16145-
<command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue>
16146-
<dev:type>
16147-
<maml:name>SwitchParameter</maml:name>
16148-
<maml:uri/>
16149-
</dev:type>
16150-
<dev:defaultValue></dev:defaultValue>
16151-
</command:parameter>
16152-
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
16153-
<maml:name>InformationAction</maml:name>
16154-
<maml:description>
16155-
<maml:para />
16156-
</maml:description>
16157-
<command:parameterValue required="true" variableLength="false">ActionPreference</command:parameterValue>
16158-
<dev:type>
16159-
<maml:name>ActionPreference</maml:name>
16160-
<maml:uri/>
16161-
</dev:type>
16162-
<dev:defaultValue></dev:defaultValue>
16163-
</command:parameter>
16164-
<command:parameter required="false" variableLength="false" globbing="false" pipelineInput="false" position="named">
16165-
<maml:name>InformationVariable</maml:name>
16166-
<maml:description>
16167-
<maml:para />
16168-
</maml:description>
16169-
<command:parameterValue required="true" variableLength="false">String</command:parameterValue>
16170-
<dev:type>
16171-
<maml:name>String</maml:name>
16172-
<maml:uri/>
16173-
</dev:type>
16174-
<dev:defaultValue></dev:defaultValue>
16175-
</command:parameter>
16176-
</command:parameters>
16177-
<command:inputTypes>
16178-
<command:inputType>
16179-
<dev:type>
16180-
<maml:name></maml:name>
16181-
<maml:uri></maml:uri>
16182-
<maml:description/>
16183-
</dev:type>
16184-
<maml:description>
16185-
<maml:para />
16186-
</maml:description>
16187-
</command:inputType>
16188-
</command:inputTypes>
16189-
<command:returnValues>
16190-
<command:returnValue>
16191-
<dev:type>
16192-
<maml:name>Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementAccessInformation</maml:name>
16193-
<maml:uri></maml:uri>
16194-
<maml:description/>
16195-
</dev:type>
16196-
<maml:description>
16197-
<maml:para />
16198-
</maml:description>
16199-
</command:returnValue>
16200-
</command:returnValues>
16201-
<command:terminatingErrors></command:terminatingErrors>
16202-
<command:nonTerminatingErrors></command:nonTerminatingErrors>
16203-
<maml:alertSet>
16204-
<maml:title></maml:title>
16205-
<maml:alert>
16206-
<maml:para />
16207-
</maml:alert>
16208-
</maml:alertSet>
16209-
<command:examples>
16210-
<command:example>
16211-
<maml:title>-------------------------- Example 1 --------------------------</maml:title>
16212-
<maml:introduction>
16213-
<maml:paragraph>PS C:\&gt;</maml:paragraph>
16214-
</maml:introduction>
16215-
<dev:code>Set-AzureRmApiManagementTenantGitAccess -Context $apimContext -Enabled $true</dev:code>
16216-
<dev:remarks>
16217-
<maml:para>Sets the Git access configuration to True.</maml:para>
16218-
<maml:para />
16219-
<maml:para />
16220-
<maml:para></maml:para>
16221-
</dev:remarks>
16222-
<command:commandLines>
16223-
<command:commandLine>
16224-
<command:commandText>
16225-
<maml:para />
16226-
</command:commandText>
16227-
</command:commandLine>
16228-
</command:commandLines>
16229-
</command:example>
16230-
</command:examples>
16231-
<maml:relatedLinks>
16232-
</maml:relatedLinks>
16233-
</command:command>
16234-
<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">
1623516059
<!--Generated by PS Cmdlet Help Editor-->
1623616060
<command:details>
1623716061
<command:name>Get-AzureRmApiManagementTenantAccess</command:name>
@@ -16528,7 +16352,7 @@ OpenId Connect Provider.</maml:para>
1652816352
</maml:introduction>
1652916353
<dev:code>Set-AzureRmApiManagementTenantAccess -Context $apimContext -Enabled $true</dev:code>
1653016354
<dev:remarks>
16531-
<maml:para>Sets the Tenant Access using REST API </maml:para>
16355+
<maml:para>Sets the Tenant Access using REST API to True.</maml:para>
1653216356
<maml:para />
1653316357
<maml:para />
1653416358
<maml:para></maml:para>

0 commit comments

Comments
 (0)