Get-AzureRmApiManagementApi

NAME Get-AzureRmApiManagementApi



SYNOPSIS

Gets an API.





SYNTAX

Get-AzureRmApiManagementApi -ApiId <String> -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>] [<CommonParameters>]



Get-AzureRmApiManagementApi -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>] -Name <String> [<CommonParameters>]



Get-AzureRmApiManagementApi -Context <PsApiManagementContext> [-DefaultProfile <IAzureContextContainer>] -ProductId <String> [<CommonParameters>]





DESCRIPTION

The Get-AzureRmApiManagementApi cmdlet gets one or more Azure API Management APIs.





PARAMETERS

-ApiId <String>

Specifies the ID of the API to get.



Required? true

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



-Name <String>

Specifies the name of the API to get.



Required? true

Position? named

Default value None

Accept pipeline input? True (ByPropertyName)

Accept wildcard characters? false



-ProductId <String>

Specifies the ID of the product for which to get the API.



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.PsApiManagementApi

The details of the Api in a given ApiManagement service



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

The list of Apis in a given ApiManagement service





NOTES









Example 1: Get all management APIs



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

PS C:\\>Get-AzureRmApiManagementApi -Context $ApiMgmtContext



This command gets all of the APIs for the specified context.





Example 2: Get a management API by ID



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

PS C:\\>Get-AzureRmApiManagementApi -Context $ApiMgmtContext -ApiId $ApiId



This command gets the API with the specified ID.





Example 3: Get a management API by name



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

PS C:\\>Get-AzureRmApiManagementApi -Context $ApiMgmtContext -Name "EchoApi"



This command gets the API with the specified name.







RELATED LINKS

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

Export-AzureRmApiManagementApi

Import-AzureRmApiManagementApi

New-AzureRmApiManagementApi

Remove-AzureRmApiManagementApi

Set-AzureRmApiManagementApi