< Back

Get-AzureRmApiManagementOperation

Tue Jan 29, 2019 9:29 pm

NAME Get-AzureRmApiManagementOperation



SYNOPSIS

Gets a list or a specified API Operation.





SYNTAX

Get-AzureRmApiManagementOperation -ApiId <String> -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>] -OperationId

<String> [<CommonParameters>]





DESCRIPTION

The Get-AzureRmApiManagementOperation gets a list or a specified API Operation.





PARAMETERS

-ApiId <String>

Specifies the identifier of the API Operation.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-Context <PsApiManagementContext>

Specifies the instance of the 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



-OperationId <String>

Specifies the operation identifier.



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

The details of the API Operation in Api Management service.



IList<Microsoft.Azure.Commands.ApiManagement.ServiceManagement.Models.PsApiManagementOperation>

The list of API Operation in Api Management service.





NOTES









Example 1: Get all API management operations



PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"

PS C:\\>Get-AzureRmApiManagementOperation -Context $apimContext -ApiId $APIId



This command gets all API management operations.





Example 2: Get an API Management operation by operation ID



PS C:\\>$apimContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"

PS C:\\>Get-AzureRmApiManagementOperation -Context $apimContext -ApiId $APIId -OperationId "Operation003"



This command gets an API management operation by operation ID named Operation0003.







RELATED LINKS

Online Version: https://docs.microsoft.com/en-us/powers ... toperation

New-AzureRmApiManagementOperation

Remove-AzureRmApiManagementOperation

Set-AzureRmApiManagementOperation