ArmApiManagementModelFactory.ApiManagementAuthorizationServerData Method

Definition

Namespace:

Azure.ResourceManager.ApiManagement.Models

Assembly:

Azure.ResourceManager.ApiManagement.dll

Package:

Azure.ResourceManager.ApiManagement v1.2.0

Source:

ArmApiManagementModelFactory.cs

Initializes a new instance of ApiManagementAuthorizationServerData.

public static Azure.ResourceManager.ApiManagement.ApiManagementAuthorizationServerData ApiManagementAuthorizationServerData (Azure.Core.ResourceIdentifier id = default, string name = default, Azure.Core.ResourceType resourceType = default, Azure.ResourceManager.Models.SystemData systemData = default, string description = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.ApiManagement.Models.AuthorizationMethod> authorizationMethods = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.ApiManagement.Models.ClientAuthenticationMethod> clientAuthenticationMethods = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.ApiManagement.Models.TokenBodyParameterContract> tokenBodyParameters = default, string tokenEndpoint = default, bool? doesSupportState = default, string defaultScope = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.ApiManagement.Models.BearerTokenSendingMethod> bearerTokenSendingMethods = default, string resourceOwnerUsername = default, string resourceOwnerPassword = default, string displayName = default, bool? useInTestConsole = default, bool? useInApiDocumentation = default, string clientRegistrationEndpoint = default, string authorizationEndpoint = default, System.Collections.Generic.IEnumerable<Azure.ResourceManager.ApiManagement.Models.GrantType> grantTypes = default, string clientId = default, string clientSecret = default);

static member ApiManagementAuthorizationServerData : Azure.Core.ResourceIdentifier * string * Azure.Core.ResourceType * Azure.ResourceManager.Models.SystemData * string * seq<Azure.ResourceManager.ApiManagement.Models.AuthorizationMethod> * seq<Azure.ResourceManager.ApiManagement.Models.ClientAuthenticationMethod> * seq<Azure.ResourceManager.ApiManagement.Models.TokenBodyParameterContract> * string * Nullable<bool> * string * seq<Azure.ResourceManager.ApiManagement.Models.BearerTokenSendingMethod> * string * string * string * Nullable<bool> * Nullable<bool> * string * string * seq<Azure.ResourceManager.ApiManagement.Models.GrantType> * string * string -> Azure.ResourceManager.ApiManagement.ApiManagementAuthorizationServerData

Public Shared Function ApiManagementAuthorizationServerData (Optional id As ResourceIdentifier = Nothing, Optional name As String = Nothing, Optional resourceType As ResourceType = Nothing, Optional systemData As SystemData = Nothing, Optional description As String = Nothing, Optional authorizationMethods As IEnumerable(Of AuthorizationMethod) = Nothing, Optional clientAuthenticationMethods As IEnumerable(Of ClientAuthenticationMethod) = Nothing, Optional tokenBodyParameters As IEnumerable(Of TokenBodyParameterContract) = Nothing, Optional tokenEndpoint As String = Nothing, Optional doesSupportState As Nullable(Of Boolean) = Nothing, Optional defaultScope As String = Nothing, Optional bearerTokenSendingMethods As IEnumerable(Of BearerTokenSendingMethod) = Nothing, Optional resourceOwnerUsername As String = Nothing, Optional resourceOwnerPassword As String = Nothing, Optional displayName As String = Nothing, Optional useInTestConsole As Nullable(Of Boolean) = Nothing, Optional useInApiDocumentation As Nullable(Of Boolean) = Nothing, Optional clientRegistrationEndpoint As String = Nothing, Optional authorizationEndpoint As String = Nothing, Optional grantTypes As IEnumerable(Of GrantType) = Nothing, Optional clientId As String = Nothing, Optional clientSecret As String = Nothing) As ApiManagementAuthorizationServerData

Parameters

id

ResourceIdentifier

The id.

name

String

The name.

resourceType

ResourceType

The resourceType.

systemData

SystemData

The systemData.

description

String

Description of the authorization server. Can contain HTML formatting tags.

authorizationMethods

IEnumerable<AuthorizationMethod>

HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.

clientAuthenticationMethods

IEnumerable<ClientAuthenticationMethod>

Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.

tokenBodyParameters

IEnumerable<TokenBodyParameterContract>

Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {"name" : "name value", "value": "a value"}.

tokenEndpoint

String

OAuth token endpoint. Contains absolute URI to entity being referenced.

doesSupportState

Nullable<Boolean>

If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.

defaultScope

String

Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.

bearerTokenSendingMethods

IEnumerable<BearerTokenSendingMethod>

Specifies the mechanism by which access token is passed to the API.

resourceOwnerUsername

String

Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.

resourceOwnerPassword

String

Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.

displayName

String

User-friendly authorization server name.

useInTestConsole

Nullable<Boolean>

If true, the authorization server may be used in the developer portal test console. True by default if no value is provided.

useInApiDocumentation

Nullable<Boolean>

If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided.

clientRegistrationEndpoint

String

Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.

authorizationEndpoint

String

OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.

grantTypes

IEnumerable<GrantType>

Form of an authorization grant, which the client uses to request the access token.

clientId

String

Client or app id registered with this authorization server.

clientSecret

String

Client or app secret registered with this authorization server. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.

Returns

ApiManagementAuthorizationServerData

A new ApiManagementAuthorizationServerData instance for mocking.