Get-AzureRmApiManagementApiRelease
Get the API Release.
Warning
The AzureRM PowerShell module has been officially deprecated as of February 29, 2024. Users are advised to migrate from AzureRM to the Az PowerShell module to ensure continued support and updates.
Although the AzureRM module may still function, it's no longer maintained or supported, placing any continued use at the user's discretion and risk. Please refer to our migration resources for guidance on transitioning to the Az module.
Syntax
Get-AzureRmApiManagementApiRelease
-Context <PsApiManagementContext>
-ApiId <String>
[-ReleaseId <String>]
[-DefaultProfile <IAzureContextContainer>]
[<CommonParameters>]
Description
The Get-AzureRmApiManagementApiRelease cmdlet gets one or more releases of the Azure API Management API.
Examples
Example 1: Get all releases of the API
PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Get-AzureRmApiManagementApiRelease -Context $ApiMgmtContext -ApiId 5adf6fbf0faadf3ad8558065
ReleaseId : 5afccaf6b89fd067426d402e
ApiId : 5adf6fbf0faadf3ad8558065
CreatedDateTime : 5/17/2018 12:21:12 AM
UpdatedDateTime : 5/17/2018 12:21:12 AM
Notes : creating a new release
Id : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Microsoft.ApiManagement/service/contoso/apis/5adf6fbf0faadf3ad8558065/releases/5afccaf6b89fd067426d402e
ResourceGroupName : Api-Default-WestUS
ServiceName : contos
This command gets all of the releases of the echo-api
API for the specified context.
Example 2: Get the release information of the particular API release
PS C:\>$ApiMgmtContext = New-AzureRmApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
PS C:\>Get-AzureRmApiManagementApiRelease -Context $ApiMgmtContext -ApiId 5adf6fbf0faadf3ad8558065 -ReleaseId 5afccaf6b89fd067426d402e
ReleaseId : 5afccaf6b89fd067426d402e
ApiId : 5adf6fbf0faadf3ad8558065
CreatedDateTime : 5/17/2018 12:21:12 AM
UpdatedDateTime : 5/17/2018 12:21:12 AM
Notes : creating a new release
Id : /subscriptions/subid/resourceGroups/Api-Default-WestUS/providers/Mi
crosoft.ApiManagement/service/contos/apis/5adf6fbf0faadf3ad8558065/releases/5afccaf6b89fd067426d402
e
ResourceGroupName : Api-Default-WestUS
ServiceName : contos
This command gets the releases information of a particular API with the specified releaseId.
Parameters
-ApiId
API identifier to look for. If specified will try to get the API by the Id.
Type: | String |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-Context
Instance of PsApiManagementContext. This parameter is required.
Type: | PsApiManagementContext |
Position: | Named |
Default value: | None |
Required: | True |
Accept pipeline input: | True |
Accept wildcard characters: | False |
-DefaultProfile
The credentials, account, tenant, and subscription used for communication with Azure.
Type: | IAzureContextContainer |
Aliases: | AzureRmContext, AzureCredential |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | False |
Accept wildcard characters: | False |
-ReleaseId
The identifier of the Release.
Type: | String |
Position: | Named |
Default value: | None |
Required: | False |
Accept pipeline input: | True |
Accept wildcard characters: | False |