ApiManagementAuthorizationServerData Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A class representing the ApiManagementAuthorizationServer data model. External OAuth authorization server settings.
public class ApiManagementAuthorizationServerData : Azure.ResourceManager.Models.ResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.ApiManagement.ApiManagementAuthorizationServerData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.ApiManagement.ApiManagementAuthorizationServerData>type ApiManagementAuthorizationServerData = class
inherit ResourceData
interface IJsonModel<ApiManagementAuthorizationServerData>
interface IPersistableModel<ApiManagementAuthorizationServerData>Public Class ApiManagementAuthorizationServerData
Inherits ResourceData
Implements IJsonModel(Of ApiManagementAuthorizationServerData), IPersistableModel(Of ApiManagementAuthorizationServerData)- Inheritance
- Implements
Constructors
| ApiManagementAuthorizationServerData() |
Initializes a new instance of ApiManagementAuthorizationServerData. |
Properties
| AuthorizationEndpoint |
OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2. |
| AuthorizationMethods |
HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional. |
| BearerTokenSendingMethods |
Specifies the mechanism by which access token is passed to the API. |
| ClientAuthenticationMethods |
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. |
| ClientId |
Client or app id registered with this authorization server. |
| ClientRegistrationEndpoint |
Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced. |
| ClientSecret |
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. |
| DefaultScope |
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. |
| Description |
Description of the authorization server. Can contain HTML formatting tags. |
| DisplayName |
User-friendly authorization server name. |
| DoesSupportState |
If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security. |
| GrantTypes |
Form of an authorization grant, which the client uses to request the access token. |
| Id |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. (Inherited from ResourceData) |
| Name |
The name of the resource. (Inherited from ResourceData) |
| ResourceOwnerPassword |
Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password. |
| ResourceOwnerUsername |
Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username. |
| ResourceType |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts". (Inherited from ResourceData) |
| SystemData |
Azure Resource Manager metadata containing createdBy and modifiedBy information. (Inherited from ResourceData) |
| TokenBodyParameters |
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 |
OAuth token endpoint. Contains absolute URI to entity being referenced. |
| UseInApiDocumentation |
If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided. |
| UseInTestConsole |
If true, the authorization server may be used in the developer portal test console. True by default if no value is provided. |
Methods
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) | (Inherited from ResourceData) |
Explicit Interface Implementations
| IJsonModel<ApiManagementAuthorizationServerData>.Create(Utf8JsonReader, ModelReaderWriterOptions) |
Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. |
| IJsonModel<ApiManagementAuthorizationServerData>.Write(Utf8JsonWriter, ModelReaderWriterOptions) |
Writes the model to the provided Utf8JsonWriter. |
| IPersistableModel<ApiManagementAuthorizationServerData>.Create(BinaryData, ModelReaderWriterOptions) |
Converts the provided BinaryData into a model. |
| IPersistableModel<ApiManagementAuthorizationServerData>.GetFormatFromOptions(ModelReaderWriterOptions) |
Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. |
| IPersistableModel<ApiManagementAuthorizationServerData>.Write(ModelReaderWriterOptions) |
Writes the model into a BinaryData. |
