Set-AzApiManagementApi

Модуль:: Az.ApiManagement Module

Изменяет API.

Синтаксис

ExpandedParameter (по умолчанию)

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>]

Описание

Командлет Set-AzApiManagementApi изменяет API управления API Azure.

Примеры

Пример 1. Изменение API

$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"

Пример 2. Добавление API в существующий 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

Этот пример добавляет API в существующий набор версий API

Пример 3. Изменение серверной службыUrl, на который указывает API

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

В этом примере обновляется ServiceUrl, на который echo-api указывает.

Параметры

-ApiId

Указывает идентификатор API для изменения.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

ExpandedParameter

Position:	Named
Обязательно:	True
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-ApiType

Тип API для создания (http, soap, websocket, graphql). Это необязательный параметр.

Свойства параметра

Тип:	Nullable<T>[PsApiManagementApiType]
Default value:	None
Допустимые значения:	Http, Soap, WebSocket, GraphQL
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-AuthorizationScope

Указывает область операций OAuth. Значение по умолчанию — $Null.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-AuthorizationServerId

Указывает идентификатор сервера авторизации OAuth. Значение по умолчанию — $Null. Этот параметр необходимо указать, если указан AuthorizationScope .

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-BearerTokenSendingMethod

Механизм сервера авторизации OpenId, с помощью которого маркер доступа передается API. См. https://datatracker.ietf.org/doc/html/rfc6749#section-4. Это необязательный параметр. Значение по умолчанию — $null.

Свойства параметра

Тип:	String[]
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-ContactEmail

Адрес электронной почты контактного лица или организации. Должен быть в формате адреса электронной почты. Это необязательный параметр.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-ContactName

Имя контактного лица или организации. Это необязательный параметр.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-ContactUrl

URL-адрес, указывающий на контактные данные. ДОЛЖЕН быть в формате URL-адреса. Это необязательный параметр.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-Context

Указывает объект PsApiManagementContext .

Свойства параметра

Тип:	PsApiManagementContext
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

ExpandedParameter

Position:	Named
Обязательно:	True
Значение из конвейера:	True
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-DefaultProfile

Учетные данные, учетная запись, клиент и подписка, используемые для обмена данными с Azure.

Свойства параметра

Тип:	IAzureContextContainer
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False
Aliases:	AzContext, AzureRmContext, AzureCredential

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-Description

Указывает описание веб-API.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-InputObject

Экземпляр PsApiManagementApi. Этот параметр является обязательным.

Свойства параметра

Тип:	PsApiManagementApi
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

ByInputObject

Position:	Named
Обязательно:	True
Значение из конвейера:	True
Значение из конвейера по имени свойства:	False
Значение из оставшихся аргументов:	False

-LicenseName

Имя лицензии, используемое для API. Это необязательный параметр.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-LicenseUrl

URL-адрес условий обслуживания для API. Это необязательный параметр.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-Name

Указывает имя веб-API.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-OpenIdProviderId

Идентификатор сервера авторизации OpenId. Это необязательный параметр. Значение по умолчанию — $null. Необходимо указать, указан ли bearerTokenSendingMethods.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-PassThru

passthru

Свойства параметра

Тип:	SwitchParameter
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-Path

Указывает путь веб-API, который является последней частью общедоступного URL-адреса API. Этот URL-адрес используется потребителями API для отправки запросов в веб-службу и должен составлять от 400 символов до 400 символов. Значение по умолчанию — $Null.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-Protocols

Задает массив протоколов веб-API. psdx_paramvalues http и https. Это веб-протоколы, через которые предоставляется API. Значение по умолчанию — $Null.

Свойства параметра

Тип:	PsApiManagementSchema[]
Default value:	None
Допустимые значения:	Http, Https, Ws, Wss
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-ServiceUrl

Указывает URL-адрес веб-службы, предоставляющей API. Этот URL-адрес используется только службой управления API Azure и не является общедоступным. URL-адрес должен иметь длину до 2000 символов.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-SubscriptionKeyHeaderName

Указывает имя заголовка ключа подписки. Значение по умолчанию — $Null.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-SubscriptionKeyQueryParamName

Указывает имя параметра строки запроса ключа подписки. Значение по умолчанию — $Null.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-SubscriptionRequired

Пометка для принудительного применения subscriptionRequired для запросов к API. Это необязательный параметр.

Свойства параметра

Тип:	SwitchParameter
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

-TermsOfServiceUrl

URL-адрес условий обслуживания для API. Это необязательный параметр.

Свойства параметра

Тип:	String
Default value:	None
Поддерживаются подстановочные знаки:	False
DontShow:	False

Наборы параметров

(All)

Position:	Named
Обязательно:	False
Значение из конвейера:	False
Значение из конвейера по имени свойства:	True
Значение из оставшихся аргументов:	False

CommonParameters

Этот командлет поддерживает общие параметры: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction и -WarningVariable. Дополнительные сведения см. в разделе about_CommonParameters.

Выходные данные

PsApiManagementApi

Обратная связь

Были ли сведения на этой странице полезными?

Поделиться через

Set-AzApiManagementApi

Синтаксис

ExpandedParameter (по умолчанию)

ByInputObject

Описание

Примеры

Пример 1. Изменение API

Пример 2. Добавление API в существующий ApiVersionSet

Пример 3. Изменение серверной службыUrl, на который указывает API

Параметры

-ApiId

Свойства параметра

Наборы параметров

-ApiType

Свойства параметра

Наборы параметров

-AuthorizationScope

Свойства параметра

Наборы параметров

-AuthorizationServerId

Свойства параметра

Наборы параметров

-BearerTokenSendingMethod

Свойства параметра

Наборы параметров

-ContactEmail

Свойства параметра

Наборы параметров

-ContactName

Свойства параметра

Наборы параметров

-ContactUrl

Свойства параметра

Наборы параметров

-Context

Свойства параметра

Наборы параметров

-DefaultProfile

Свойства параметра

Наборы параметров

-Description

Свойства параметра

Наборы параметров

-InputObject

Свойства параметра

Наборы параметров

-LicenseName

Свойства параметра

Наборы параметров

-LicenseUrl

Свойства параметра

Наборы параметров

-Name

Свойства параметра

Наборы параметров

-OpenIdProviderId

Свойства параметра

Наборы параметров

-PassThru

Свойства параметра

Наборы параметров

-Path

Свойства параметра

Наборы параметров

-Protocols

Свойства параметра

Наборы параметров

-ServiceUrl

Свойства параметра

Наборы параметров

-SubscriptionKeyHeaderName

Свойства параметра

Наборы параметров

-SubscriptionKeyQueryParamName

Свойства параметра

Наборы параметров

-SubscriptionRequired

Свойства параметра

Наборы параметров