< Back
Set-AzureRmApiManagementApi
Post
NAME Set-AzureRmApiManagementApi
SYNOPSIS
Modifies an API.
SYNTAX
Set-AzureRmApiManagementApi -ApiId <String> [-AuthorizationScope <String>] [-AuthorizationServerId <String>] -Context <PsApiManagementContext>
[-DefaultProfile <IAzureContextContainer>] [-Description <String>] -Name <String> [-PassThru] [-Path <String>] -Protocols {Http | Https}
-ServiceUrl <String> [-SubscriptionKeyHeaderName <String>] [-SubscriptionKeyQueryParamName <String>] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmApiManagementApi cmdlet modifies an Azure API Management API.
PARAMETERS
-ApiId <String>
Specifies the ID of the API to modify.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AuthorizationScope <String>
Specifies the OAuth operations scope. The default value is $Null.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AuthorizationServerId <String>
Specifies the OAuth authorization server identifier. The default value is $Null. You must specify this parameter if AuthorizationScope is
specified.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Context <PsApiManagementContext>
Specifies a PsApiManagementContext object.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Description <String>
Specifies a description for the web API.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the name of the web API.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
passthru
Required? false
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Path <String>
Specifies the web API path, which is the last part of the API's public URL. This URL is used by API consumers to send requests to the web
service, and must be one to 400 characters long. The default value is $Null.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Protocols <PsApiManagementSchema[]>
Specifies an array of web API protocols. psdx_paramvalues http and https. These are the web protocols over which the API is made available.
The default value is $Null.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ServiceUrl <String>
Specifies the URL of the web service that exposes the API. This URL is used only by Azure API Management, and is not made public. The URL must
be one to 2000 characters long.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SubscriptionKeyHeaderName <String>
Specifies the name of the subscription key header. The default value is $Null.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SubscriptionKeyQueryParamName <String>
Specifies the name of the subscription key query string parameter. The default value is $Null.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi
NOTES
Example 1 Modify an API
PS C:\\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\\>Set-AzureRmApiManagementApi -Context $ApiMgmtContext -Name "EchoApi" -ServiceUrl "https://contoso.com/apis/echo" -Protocols @('https')
-Description "Responds with what was sent" -Path "echo"
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... agementapi
Export-AzureRmApiManagementApi
Get-AzureRmApiManagementApi
Import-AzureRmApiManagementApi
New-AzureRmApiManagementApi
Remove-AzureRmApiManagementApi
SYNOPSIS
Modifies an API.
SYNTAX
Set-AzureRmApiManagementApi -ApiId <String> [-AuthorizationScope <String>] [-AuthorizationServerId <String>] -Context <PsApiManagementContext>
[-DefaultProfile <IAzureContextContainer>] [-Description <String>] -Name <String> [-PassThru] [-Path <String>] -Protocols {Http | Https}
-ServiceUrl <String> [-SubscriptionKeyHeaderName <String>] [-SubscriptionKeyQueryParamName <String>] [<CommonParameters>]
DESCRIPTION
The Set-AzureRmApiManagementApi cmdlet modifies an Azure API Management API.
PARAMETERS
-ApiId <String>
Specifies the ID of the API to modify.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AuthorizationScope <String>
Specifies the OAuth operations scope. The default value is $Null.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-AuthorizationServerId <String>
Specifies the OAuth authorization server identifier. The default value is $Null. You must specify this parameter if AuthorizationScope is
specified.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Context <PsApiManagementContext>
Specifies a PsApiManagementContext object.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-DefaultProfile <IAzureContextContainer>
The credentials, account, tenant, and subscription used for communication with azure.
Required? false
Position? named
Default value None
Accept pipeline input? False
Accept wildcard characters? false
-Description <String>
Specifies a description for the web API.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the name of the web API.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-PassThru [<SwitchParameter>]
passthru
Required? false
Position? named
Default value False
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Path <String>
Specifies the web API path, which is the last part of the API's public URL. This URL is used by API consumers to send requests to the web
service, and must be one to 400 characters long. The default value is $Null.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Protocols <PsApiManagementSchema[]>
Specifies an array of web API protocols. psdx_paramvalues http and https. These are the web protocols over which the API is made available.
The default value is $Null.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-ServiceUrl <String>
Specifies the URL of the web service that exposes the API. This URL is used only by Azure API Management, and is not made public. The URL must
be one to 2000 characters long.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SubscriptionKeyHeaderName <String>
Specifies the name of the subscription key header. The default value is $Null.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-SubscriptionKeyQueryParamName <String>
Specifies the name of the subscription key query string parameter. The default value is $Null.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug,
ErrorAction, ErrorVariable, WarningAction, WarningVariable,
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (http://go.microsoft.com/fwlink/?LinkID=113216).
INPUTS
None
This cmdlet does not accept any input.
OUTPUTS
Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementApi
NOTES
Example 1 Modify an API
PS C:\\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\\>Set-AzureRmApiManagementApi -Context $ApiMgmtContext -Name "EchoApi" -ServiceUrl "https://contoso.com/apis/echo" -Protocols @('https')
-Description "Responds with what was sent" -Path "echo"
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... agementapi
Export-AzureRmApiManagementApi
Get-AzureRmApiManagementApi
Import-AzureRmApiManagementApi
New-AzureRmApiManagementApi
Remove-AzureRmApiManagementApi