Dela via

Export-AzApiManagementApi

  • Referens
Modul:
Az.ApiManagement

Exporterar ett API till en fil.

Syntax

Export-AzApiManagementApi
      -Context <PsApiManagementContext>
      -ApiId <String>
      [-ApiRevision <String>]
      -SpecificationFormat <PsApiManagementApiFormat>
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]
Export-AzApiManagementApi
      -Context <PsApiManagementContext>
      -ApiId <String>
      [-ApiRevision <String>]
      -SpecificationFormat <PsApiManagementApiFormat>
      -SaveAs <String>
      [-Force]
      [-PassThru]
      [-DefaultProfile <IAzureContextContainer>]
      [-WhatIf]
      [-Confirm]
      [<CommonParameters>]

Description

Cmdleten Export-AzApiManagementApi exporterar ett Azure API Management-API till en fil i något av de format som stöds.

Exempel

Exempel 1: Exportera ett API i WADL-format (Web Application Description Language)

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Export-AzApiManagementApi -Context $ApiMgmtContext -ApiId "0123456789" -SpecificationFormat "Wadl" -SaveAs "C:\contoso\specifications\0123456789.wadl"

Det här kommandot exporterar ett API till en WADL-fil.

Exempel 2: Exportera ett API i OpenApi 3.0-specifikationsformat som Json-dokument

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Export-AzApiManagementApi -Context $ApiMgmtContext -ApiId swagger-petstore -SpecificationFormat OpenApiJson -SaveAs D:\github\petstore.json

Det här kommandot exporterar api-definitioner i Open Api-format som Json-dokument

Parametrar

-ApiId

Anger ID:t för API:et som ska exporteras.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-ApiRevision

Identifierare för API Revision. Den här parametern är valfri. Om det inte anges görs exporten för den aktiva API-revisionen.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-Confirm

Uppmanar dig att bekräfta innan du kör cmdleten.

Typ:SwitchParameter
Alias:cf
Position:Named
Standardvärde:False
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Context

Anger ett PsApiManagementContext- objekt.

Typ:PsApiManagementContext
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-DefaultProfile

Autentiseringsuppgifter, konto, klientorganisation och prenumeration som används för kommunikation med Azure.

Typ:IAzureContextContainer
Alias:AzContext, AzureRmContext, AzureCredential
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

-Force

Anger att den här åtgärden skriver över filen med samma namn om den redan finns.

Typ:SwitchParameter
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-PassThru

Anger att den här åtgärden returnerar $True om API:et exporteras eller $False på annat sätt.

Typ:SwitchParameter
Position:Named
Standardvärde:None
Obligatorisk:False
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-SaveAs

Anger den filsökväg som det exporterade API:et ska sparas till.

Typ:String
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-SpecificationFormat

Anger API-formatet. psdx_paramvalues Wadl, Wsdl, Swagger, OpenApi och OpenApiJson

Typ:PsApiManagementApiFormat
Godkända värden:Wadl, Swagger, Wsdl, OpenApi, OpenApiJson
Position:Named
Standardvärde:None
Obligatorisk:True
Godkänn pipeline-indata:True
Godkänn jokertecken:False

-WhatIf

Visar vad som skulle hända om kommandot körs. Cmdleten körs inte.

Typ:SwitchParameter
Alias:wi
Position:Named
Standardvärde:False
Obligatorisk:False
Godkänn pipeline-indata:False
Godkänn jokertecken:False

Indata

Utdata