Delen via

Set-AzApiManagementApi

Module:
Az.ApiManagement Module

Hiermee wijzigt u een API.

Syntax

ExpandedParameter (Standaard) 

Set-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>]
    [-SubscriptionRequired]
    [-PassThru]
    [-ApiType <PsApiManagementApiType>]
    [-TermsOfServiceUrl <String>]
    [-ContactName <String>]
    [-ContactUrl <String>]
    [-ContactEmail <String>]
    [-LicenseName <String>]
    [-LicenseUrl <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

ByInputObject 

Set-AzApiManagementApi
    -InputObject <PsApiManagementApi>
    [-Name <String>]
    [-Description <String>]
    [-ServiceUrl <String>]
    [-Path <String>]
    [-Protocols <PsApiManagementSchema[]>]
    [-AuthorizationServerId <String>]
    [-AuthorizationScope <String>]
    [-OpenIdProviderId <String>]
    [-BearerTokenSendingMethod <String[]>]
    [-SubscriptionKeyHeaderName <String>]
    [-SubscriptionKeyQueryParamName <String>]
    [-SubscriptionRequired]
    [-PassThru]
    [-ApiType <PsApiManagementApiType>]
    [-TermsOfServiceUrl <String>]
    [-ContactName <String>]
    [-ContactUrl <String>]
    [-ContactEmail <String>]
    [-LicenseName <String>]
    [-LicenseUrl <String>]
    [-DefaultProfile <IAzureContextContainer>]
    [<CommonParameters>]

Description

De cmdlet Set-AzApiManagementApi wijzigt een Azure API Management-API.

Voorbeelden

Voorbeeld 1: Een API wijzigen

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementApi -Context $ApiMgmtContext -Name "EchoApi" -ServiceUrl "https://contoso.com/apis/echo" -Protocols @('https') -Description "Responds with what was sent" -Path "echo"

Voorbeeld 2: Een API toevoegen aan een bestaande ApiVersionSet

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
$versionSet = New-AzApiManagementApiVersionSet -Context $context -Name "Echo API Version Set" -Scheme Segment -Description "version set sample"
$api = Get-AzApiManagementApi -Context $ApiMgmtContext -ApiId "echo-api"
$api.ApiVersionSetId = $versionSet.Id
$api.ApiVersion = "v1"
$api.ApiVersionSetDescription = $versionSet.Description
Set-AzApiManagementApi -InputObject $api -PassThru

In dit voorbeeld wordt een API toegevoegd aan een bestaande API-versieset

Voorbeeld 3: De back-endserviceurl wijzigen waarnaar de API verwijst

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
$updatedApiServiceUrl = "http://newechoapi.cloudapp.net/updateapi"
$updatedApi = Set-AzApiManagementApi -Context $ApiMgmtContext -ApiId $echoApiId -ServiceUrl $updatedApiServiceUrl

In dit voorbeeld wordt de ServiceUrl bijgewerkt waarop wordt echo-api verwijst.

Parameters

-ApiId

Hiermee geeft u de id van de API die moet worden gewijzigd.

Parametereigenschappen

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

Parametersets

ExpandedParameter
Position:Named
Verplicht:True
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

-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

ExpandedParameter
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

-InputObject

Exemplaar van PsApiManagementApi. Deze parameter is vereist.

Parametereigenschappen

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

Parametersets

ByInputObject
Position:Named
Verplicht:True
Waarde uit pijplijn:True
Waarde uit pijplijn op eigenschapsnaam:False
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.

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

-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

-PassThru

passthru

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

-Path

Hiermee geeft u het web-API-pad op. Dit is het laatste deel van de openbare URL van de API. 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: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. psdx_paramvalues http en 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:False
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: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.

Invoerwaarden

PsApiManagementContext

String

PsApiManagementApi

PsApiManagementSchema

SwitchParameter

Uitvoerwaarden

PsApiManagementApi