New-AzApiManagementApi

Module:: Az.ApiManagement Module

Hiermee maakt u een API.

Syntax

Default (Standaard)

New-AzApiManagementApi
    -Context <PsApiManagementContext>
    [-ApiId <String>]
    -Name <String>
    [-Description <String>]
    -ServiceUrl <String>
    -Path <String>
    -Protocols <PsApiManagementSchema[]>
    [-AuthorizationServerId <String>]
    [-AuthorizationScope <String>]
    [-OpenIdProviderId <String>]
    [-BearerTokenSendingMethod <String[]>]
    [-SubscriptionKeyHeaderName <String>]
    [-SubscriptionKeyQueryParamName <String>]
    [-ProductIds <String[]>]
    [-SubscriptionRequired]
    [-ApiVersionDescription <String>]
    [-ApiVersionSetId <String>]
    [-ApiVersion <String>]
    [-SourceApiId <String>]
    [-SourceApiRevision <String>]
    [-ApiType <PsApiManagementApiType>]
    [-TermsOfServiceUrl <String>]
    [-ContactName <String>]
    [-ContactUrl <String>]
    [-ContactEmail <String>]
    [-LicenseName <String>]
    [-LicenseUrl <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

De cmdlet New-AzApiManagementApi maakt een Azure API Management-API.

Voorbeelden

Voorbeeld 1: Een API maken

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
New-AzApiManagementApi -Context $ApiMgmtContext -Name "Echo api" -ServiceUrl "https://contoso.com/apis/echo" -Protocols @("http", "https") -Path "testapi"

Met deze opdracht maakt u een API met de naam EchoApi met de opgegeven URL.

Voorbeeld 2: Een API maken door alle bewerkingen, tags, producten en beleidsregels van echo-api en in een ApiVersionSet te kopiëren

$context = New-AzApiManagementContext -ResourceId /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso
$versionSet = Get-AzApiManagementApiVersionSet -Context $context -ApiVersionSetId "xmsVersionSet"
New-AzApiManagementApi -Context $context -Name "echoapiv4" -Description "Create Echo Api V4" -SubscriptionRequired -ServiceUrl "https://echoapi.cloudapp.net/v4" -Path "echov3" -Protocols @("http", "https") -ApiVersionSetId $versionSet.ApiVersionSetId -SourceApiId "echo-api" -ApiVersion "v4"

ApiId                         : 691b7d410125414a929c108541c60e06
Name                          : echoapiv4
Description                   : Create Echo Api V4
ServiceUrl                    : https://echoapi.cloudapp.net/v4
Path                          : echov3
ApiType                       : http
Protocols                     : {Http, Https}
AuthorizationServerId         :
AuthorizationScope            :
OpenidProviderId              :
BearerTokenSendingMethod      : {}
SubscriptionKeyHeaderName     : Ocp-Apim-Subscription-Key
SubscriptionKeyQueryParamName : subscription-key
ApiRevision                   : 1
ApiVersion                    : v4
IsCurrent                     : True
IsOnline                      : False
SubscriptionRequired          : True
ApiRevisionDescription        :
ApiVersionSetDescription      :
ApiVersionSetId               : /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso/apiVersionSets/xmsVersionSet
Id                            : /subscriptions/subid/resourceGroups/Api-Default-West-US/providers/Microsoft.ApiManagement/service/contoso/apis/691b7d410125414a929c108541c60e06
ResourceGroupName             : Api-Default-West-US
ServiceName                   : contoso

Met deze opdracht maakt u een API echoapiv3 in ApiVersionSet xmsVersionSet en kopieert u alle bewerkingen, tags en beleidsregels van de bron-API echo-api. Het overschrijft het SubscriptionRequired, ServiceUrl, Path, Protocols

Voorbeeld 3

Hiermee maakt u een API. (autogenerated)

New-AzApiManagementApi -ApiId '0001' -Context <PsApiManagementContext> -Name 'Echo api' -Path 'echov3' -Protocols Http -ServiceUrl 'https://contoso.com/apis/echo'

Parameters

-ApiId

Hiermee geeft u de id van de API die moet worden gemaakt. Als u deze parameter niet opgeeft, genereert deze cmdlet een id voor u.

Parametereigenschappen

Type:	String
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	True
Waarde van resterende argumenten:	False

-ApiType

Type API dat moet worden gemaakt (http, soap, websocket, graphql). Deze parameter is optioneel.

Parametereigenschappen

Type:	Nullable<T>[PsApiManagementApiType]
Default value:	None
Geaccepteerde waarden:	Http, Soap, WebSocket, GraphQL
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	True
Waarde van resterende argumenten:	False

-ApiVersion

Api-versie van de API die moet worden gemaakt. Deze parameter is optioneel.

Parametereigenschappen

Type:	String
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	True
Waarde van resterende argumenten:	False

-ApiVersionDescription

Beschrijving van api-versie. Deze parameter is optioneel.

Parametereigenschappen

Type:	String
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	True
Waarde van resterende argumenten:	False

-ApiVersionSetId

Een resource-id voor de gerelateerde API-versieset. Deze parameter is optioneel.

Parametereigenschappen

Type:	String
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	True
Waarde van resterende argumenten:	False

-AuthorizationScope

Hiermee geeft u het OAuth-bewerkingsbereik. De standaardwaarde is $Null.

Parametereigenschappen

Type:	String
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	True
Waarde van resterende argumenten:	False

-AuthorizationServerId

Hiermee geeft u de OAuth-autorisatieserver-id. De standaardwaarde is $Null. U moet deze parameter opgeven als AuthorizationScope is opgegeven.

Parametereigenschappen

Type:	String
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	True
Waarde van resterende argumenten:	False

-BearerTokenSendingMethod

OpenId-autorisatieservermechanisme waarmee het toegangstoken wordt doorgegeven aan de API. Raadpleeg https://datatracker.ietf.org/doc/html/rfc6749#section-4. Deze parameter is optioneel. De standaardwaarde is $null.

Parametereigenschappen

Type:	String[]
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	True
Waarde van resterende argumenten:	False

-ContactEmail

Het e-mailadres van de contactpersoon/organisatie. MOET de indeling van een e-mailadres hebben. Deze parameter is optioneel.

Parametereigenschappen

Type:	String
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	True
Waarde van resterende argumenten:	False

-ContactName

De identificatienaam van de contactpersoon/organisatie. Deze parameter is optioneel.

Parametereigenschappen

Type:	String
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	True
Waarde van resterende argumenten:	False

-ContactUrl

De URL die verwijst naar de contactgegevens. MOET de indeling van een URL hebben. Deze parameter is optioneel.

Parametereigenschappen

Type:	String
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	True
Waarde van resterende argumenten:	False

-Context

Hiermee geeft u een PsApiManagementContext-object .

Parametereigenschappen

Type:	PsApiManagementContext
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	True
Waarde uit pijplijn:	True
Waarde uit pijplijn op eigenschapsnaam:	True
Waarde van resterende argumenten:	False

-DefaultProfile

De referenties, het account, de tenant en het abonnement die worden gebruikt voor communicatie met Azure.

Parametereigenschappen

Type:	IAzureContextContainer
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False
Aliassen:	AzContext, AzureRmContext, AzureCredential

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	False
Waarde van resterende argumenten:	False

-Description

Hiermee geeft u een beschrijving voor de web-API.

Parametereigenschappen

Type:	String
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	True
Waarde van resterende argumenten:	False

-LicenseName

De licentienaam die wordt gebruikt voor de API. Deze parameter is optioneel.

Parametereigenschappen

Type:	String
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	True
Waarde van resterende argumenten:	False

-LicenseUrl

Een URL naar de servicevoorwaarden voor de API. Deze parameter is optioneel.

Parametereigenschappen

Type:	String
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	True
Waarde van resterende argumenten:	False

-Name

Hiermee geeft u de naam van de web-API. Dit is de openbare naam van de API, zoals deze wordt weergegeven in de ontwikkelaars- en beheerportals.

Parametereigenschappen

Type:	String
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	True
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	True
Waarde van resterende argumenten:	False

-OpenIdProviderId

OpenId-autorisatieserver-id. Deze parameter is optioneel. De standaardwaarde is $null. Moet worden opgegeven als BearerTokenSendingMethods is opgegeven.

Parametereigenschappen

Type:	String
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	True
Waarde van resterende argumenten:	False

-Path

Hiermee geeft u het web-API-pad op. Dit is het laatste deel van de openbare URL van de API en komt overeen met het achtervoegsel van de web-API in de beheerportal. Deze URL wordt door API-gebruikers gebruikt voor het verzenden van aanvragen naar de webservice en moet één tot 400 tekens lang zijn. De standaardwaarde is $Null.

Parametereigenschappen

Type:	String
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	True
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	True
Waarde van resterende argumenten:	False

-ProductIds

Hiermee geeft u een matrix van product-id's op waaraan de nieuwe API moet worden toegevoegd.

Parametereigenschappen

Type:	String[]
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	True
Waarde van resterende argumenten:	False

-Protocols

Hiermee geeft u een matrix van web-API-protocollen. Geldige waarden zijn http, https. Dit zijn de webprotocollen waarover de API beschikbaar wordt gesteld. De standaardwaarde is $Null.

Parametereigenschappen

Type:	PsApiManagementSchema[]
Default value:	None
Geaccepteerde waarden:	Http, Https, Ws, Wss
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	True
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	True
Waarde van resterende argumenten:	False

-ServiceUrl

Hiermee geeft u de URL op van de webservice die de API beschikbaar maakt. Deze URL wordt alleen gebruikt door Azure API Management en wordt niet openbaar gemaakt. De URL moet één tot 2000 tekens lang zijn.

Parametereigenschappen

Type:	String
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	True
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	True
Waarde van resterende argumenten:	False

-SourceApiId

Api-id van de bron-API. Deze parameter is optioneel.

Parametereigenschappen

Type:	String
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	True
Waarde van resterende argumenten:	False

-SourceApiRevision

Api-revisie van de bron-API. Deze parameter is optioneel.

Parametereigenschappen

Type:	String
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	True
Waarde van resterende argumenten:	False

-SubscriptionKeyHeaderName

Hiermee geeft u de naam van de header van de abonnementssleutel op. De standaardwaarde is $Null.

Parametereigenschappen

Type:	String
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	True
Waarde van resterende argumenten:	False

-SubscriptionKeyQueryParamName

Hiermee geeft u de naam van de queryreeksparameter voor de abonnementssleutel op. De standaardwaarde is $Null.

Parametereigenschappen

Type:	String
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	True
Waarde van resterende argumenten:	False

-SubscriptionRequired

Vlag voor het afdwingen van SubscriptionRequired voor aanvragen naar de API. Deze parameter is optioneel.

Parametereigenschappen

Type:	SwitchParameter
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	True
Waarde van resterende argumenten:	False

-TermsOfServiceUrl

Een URL naar de servicevoorwaarden voor de API. Deze parameter is optioneel.

Parametereigenschappen

Type:	String
Default value:	None
Ondersteunt jokertekens:	False
DontShow:	False

Parametersets

(All)

Position:	Named
Verplicht:	False
Waarde uit pijplijn:	False
Waarde uit pijplijn op eigenschapsnaam:	True
Waarde van resterende argumenten:	False

CommonParameters

Deze cmdlet ondersteunt de algemene parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction en -WarningVariable. Zie about_CommonParametersvoor meer informatie.

Uitvoerwaarden

PsApiManagementApi

Feedback

Is deze pagina nuttig?