< Back
Set-AzureRmApiManagementOperation
Post
NAME Set-AzureRmApiManagementOperation
SYNOPSIS
Sets API operation details.
SYNTAX
Set-AzureRmApiManagementOperation -ApiId <String> -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>] [-Description
<String>] -Method <String> -Name <String> -OperationId <String> [-PassThru] [-Request <PsApiManagementRequest>] [-Responses
<PsApiManagementResponse[]>] [-TemplateParameters <PsApiManagementParameter[]>] -UrlTemplate <String> [<CommonParameters>]
DESCRIPTION
The Set-AzureRmApiManagementOperation cmdlet sets API operation details.
PARAMETERS
-ApiId <String>
Specifies the identifier of the API.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Context <PsApiManagementContext>
Specifies an instance of PsApiManagementContext .
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 the description of the new operation.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Method <String>
Specifies the HTTP method of the new operation.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the display name of the new operation.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-OperationId <String>
Specifies the identifier of the existing operation.
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
-Request <PsApiManagementRequest>
Specifies the operation request details.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Responses <PsApiManagementResponse[]>
Specifies an array of possible operation responses.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-TemplateParameters <PsApiManagementParameter[]>
Specifies an array or parameters defined in parameter UrlTemplate . If you do not specify a value, a default value will be generated based on
the UrlTemplate. Use the parameter to give more details on parameters such as description, type, and other possible values.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-UrlTemplate <String>
Specifies the URL template. For instance: customers/{cid}/orders/{oid}/?date={date}.
Required? true
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.PsApiManagementOperation
NOTES
Example 1: Set the operation details
PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\\>New-AzureRmApiManagementOperation -Context $apimContext -ApiId $APIID -OperationId $OperationId -Name "Get Resource" -Method GET
-UrlTemplate "/newresource" -Description "Use this operation to get newresource"
This command sets the operation details for API management.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... toperation
Get-AzureRmApiManagementOperation
New-AzureRmApiManagementOperation
Remove-AzureRmApiManagementOperation
SYNOPSIS
Sets API operation details.
SYNTAX
Set-AzureRmApiManagementOperation -ApiId <String> -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>] [-Description
<String>] -Method <String> -Name <String> -OperationId <String> [-PassThru] [-Request <PsApiManagementRequest>] [-Responses
<PsApiManagementResponse[]>] [-TemplateParameters <PsApiManagementParameter[]>] -UrlTemplate <String> [<CommonParameters>]
DESCRIPTION
The Set-AzureRmApiManagementOperation cmdlet sets API operation details.
PARAMETERS
-ApiId <String>
Specifies the identifier of the API.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Context <PsApiManagementContext>
Specifies an instance of PsApiManagementContext .
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 the description of the new operation.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Method <String>
Specifies the HTTP method of the new operation.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Name <String>
Specifies the display name of the new operation.
Required? true
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-OperationId <String>
Specifies the identifier of the existing operation.
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
-Request <PsApiManagementRequest>
Specifies the operation request details.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-Responses <PsApiManagementResponse[]>
Specifies an array of possible operation responses.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-TemplateParameters <PsApiManagementParameter[]>
Specifies an array or parameters defined in parameter UrlTemplate . If you do not specify a value, a default value will be generated based on
the UrlTemplate. Use the parameter to give more details on parameters such as description, type, and other possible values.
Required? false
Position? named
Default value None
Accept pipeline input? True (ByPropertyName)
Accept wildcard characters? false
-UrlTemplate <String>
Specifies the URL template. For instance: customers/{cid}/orders/{oid}/?date={date}.
Required? true
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.PsApiManagementOperation
NOTES
Example 1: Set the operation details
PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\\>New-AzureRmApiManagementOperation -Context $apimContext -ApiId $APIID -OperationId $OperationId -Name "Get Resource" -Method GET
-UrlTemplate "/newresource" -Description "Use this operation to get newresource"
This command sets the operation details for API management.
RELATED LINKS
Online Version: https://docs.microsoft.com/en-us/powers ... toperation
Get-AzureRmApiManagementOperation
New-AzureRmApiManagementOperation
Remove-AzureRmApiManagementOperation