Set-AzApiManagementAuthorizationServer

Модуль:

Az.ApiManagement

Изменяет сервер авторизации.

Синтаксис

Set-AzApiManagementAuthorizationServer
   -Context <PsApiManagementContext>
   -ServerId <String>
   -Name <String>
   [-Description <String>]
   -ClientRegistrationPageUrl <String>
   -AuthorizationEndpointUrl <String>
   -TokenEndpointUrl <String>
   -ClientId <String>
   [-ClientSecret <String>]
   [-AuthorizationRequestMethods <PsApiManagementAuthorizationRequestMethod[]>]
   -GrantTypes <PsApiManagementGrantType[]>
   -ClientAuthenticationMethods <PsApiManagementClientAuthenticationMethod[]>
   [-TokenBodyParameters <Hashtable>]
   [-SupportState <Boolean>]
   [-DefaultScope <String>]
   -AccessTokenSendingMethods <PsApiManagementAccessTokenSendingMethod[]>
   [-ResourceOwnerUsername <String>]
   [-ResourceOwnerPassword <String>]
   [-PassThru]
   [-DefaultProfile <IAzureContextContainer>]
   [<CommonParameters>]

Описание

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

Примеры

Пример 1. Изменение сервера авторизации

$ApiMgmtContext = New-AzApiManagementContext -ResourceGroupName "Api-Default-WestUS" -ServiceName "contoso"
Set-AzApiManagementAuthorizationServer -Context $ApiMgmtContext -ServerId 0123456789 -Name "Contoso OAuth2 server" -ClientRegistrationPageUrl "https://contoso/signupv2" -AuthorizationEndpointUrl "https://contoso/authv2" -TokenEndpointUrl "https://contoso/tokenv2" -ClientId "clientid" -ClientSecret "e041ed1b660b4eadbad5a29d066e6e88" -AuthorizationRequestMethods @('Get') -GrantTypes @( 'AuthorizationCode', 'Implicit', 'ClientCredentials') -ClientAuthenticationMethods @('Basic') -TokenBodyParameters @{'par1'='val1'} -AccessTokenSendingMethods @('AuthorizationHeader')

Эта команда изменяет указанный сервер авторизации управления API.

Пример 2

Изменяет сервер авторизации. (автоматическое создание)

Set-AzApiManagementAuthorizationServer -AccessTokenSendingMethods AuthorizationHeader -AuthorizationEndpointUrl 'https://contoso/authv2' -AuthorizationRequestMethods Get -ClientAuthenticationMethods Basic -ClientId 'clientid' -ClientRegistrationPageUrl 'https://contoso/signupv2' -ClientSecret '0000000000000000000000000000000000000' -Context <PsApiManagementContext> -DefaultScope <String> -GrantTypes AuthorizationCode -Name 'Contoso OAuth2 server' -ServerId 0123456789 -TokenEndpointUrl 'https://contoso/tokenv2'

Параметры

-AccessTokenSendingMethods

Задает массив методов для отправки маркера доступа. psdx_paramvalues AuthorizationHeader и Query.

Тип:	PsApiManagementAccessTokenSendingMethod[]
Допустимые значения:	AuthorizationHeader, Query
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-AuthorizationEndpointUrl

Указывает конечную точку авторизации для проверки подлинности владельцев ресурсов и получения грантов авторизации.

Тип:	String
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-AuthorizationRequestMethods

Задает массив методов запроса авторизации. psdx_paramvalues GET и POST. Значением по умолчанию является GET.

Тип:	PsApiManagementAuthorizationRequestMethod[]
Допустимые значения:	Get, Post, Head, Options, Trace, Put, Patch, Delete
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-ClientAuthenticationMethods

Задает массив методов проверки подлинности клиента. psdx_paramvalues базовый и основной текст.

Тип:	PsApiManagementClientAuthenticationMethod[]
Допустимые значения:	Basic, Body
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-ClientId

Указывает идентификатор клиента консоли разработчика, которая является клиентским приложением.

Тип:	String
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-ClientRegistrationPageUrl

Указывает конечную точку регистрации клиента для регистрации клиентов на сервере авторизации и получения учетных данных клиента.

Тип:	String
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-ClientSecret

Указывает секрет клиента консоли разработчика, который является клиентским приложением.

Тип:	String
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-Context

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

Тип:	PsApiManagementContext
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-DefaultProfile

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

Тип:	IAzureContextContainer
Aliases:	AzContext, AzureRmContext, AzureCredential
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	False
Принять подстановочные знаки:	False

-DefaultScope

Указывает область по умолчанию для сервера авторизации.

Тип:	String
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-Description

Указывает описание сервера авторизации.

Тип:	String
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-GrantTypes

Задает массив типов предоставления. psdx_paramvalues

• Код авторизации
• ClientCredentials
• Подразумеваемый
• ResourceOwnerPassword

Тип:	PsApiManagementGrantType[]
Допустимые значения:	AuthorizationCode, Implicit, ResourceOwnerPassword, ClientCredentials
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-Name

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

Тип:	String
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-PassThru

passthru

Тип:	SwitchParameter
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-ResourceOwnerPassword

Указывает пароль владельца ресурса. Этот параметр необходимо указать, если ResourceOwnerPassword указан параметром GrantTypes.

Тип:	String
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-ResourceOwnerUsername

Указывает имя пользователя владельца ресурса. Этот параметр необходимо указать, если ResourceOwnerPassword указан параметром GrantTypes.

Тип:	String
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-ServerId

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

Тип:	String
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-SupportState

Указывает, следует ли поддерживать параметр состояния.

Тип:	Nullable<T>[Boolean]
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-TokenBodyParameters

Задает дополнительные параметры тела с помощью формата application/x-www-form-urlencoded.

Тип:	Hashtable
Position:	Named
Default value:	None
Обязательно:	False
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

-TokenEndpointUrl

Указывает конечную точку маркера для клиентов для получения маркеров доступа в обмен на предоставление авторизации или маркеры обновления.

Тип:	String
Position:	Named
Default value:	None
Обязательно:	True
Принять входные данные конвейера:	True
Принять подстановочные знаки:	False

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

PsApiManagementContext

String

PsApiManagementAuthorizationRequestMethod[]

PsApiManagementGrantType[]

PsApiManagementClientAuthenticationMethod[]

Hashtable

Nullable<T>[[System.Boolean, System.Private.CoreLib, Version=4.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]]

PsApiManagementAccessTokenSendingMethod[]

SwitchParameter

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

PsApiManagementOAuth2AuthorizationServer

Связанные ссылки

• Get-AzApiManagementAuthorizationServer
• New-AzApiManagementAuthorizationServer
• Remove-AzApiManagementAuthorizationServer