Compartir a través de

Servicio Microsoft.ApiManagement/authorizationServers 2021-12-01-preview

  • Artículo

Definición de recursos de Bicep

El tipo de recurso service/authorizationServers se puede implementar con operaciones que tienen como destino:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.ApiManagement/service/authorizationServers, agregue lo siguiente a la plantilla de Bicep.

resource symbolicname 'Microsoft.ApiManagement/service/authorizationServers@2021-12-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    authorizationEndpoint: 'string'
    authorizationMethods: [
      'string'
    ]
    bearerTokenSendingMethods: [
      'string'
    ]
    clientAuthenticationMethod: [
      'string'
    ]
    clientId: 'string'
    clientRegistrationEndpoint: 'string'
    clientSecret: 'string'
    defaultScope: 'string'
    description: 'string'
    displayName: 'string'
    grantTypes: [
      'string'
    ]
    resourceOwnerPassword: 'string'
    resourceOwnerUsername: 'string'
    supportState: bool
    tokenBodyParameters: [
      {
        name: 'string'
        value: 'string'
      }
    ]
    tokenEndpoint: 'string'
  }
}

Valores de propiedad

AuthorizationServerContractProperties

Nombre Descripción Valor
authorizationEndpoint Punto de conexión de autorización de OAuth. Consulte http://tools.ietf.org/html/rfc6749#section-3.2. string (obligatorio)
authorizationMethods Verbos HTTP admitidos por el punto de conexión de autorización. GET debe estar siempre presente. POST es opcional. Matriz de cadenas que contiene cualquiera de:
'DELETE'
'GET'
'HEAD'
'OPTIONS'
'PATCH'
'POST'
'PUT'
'TRACE'
bearerTokenSendingMethods Especifica el mecanismo por el que se pasa el token de acceso a la API. Matriz de cadenas que contiene cualquiera de:
'authorizationHeader'
'query'
clientAuthenticationMethod Método de autenticación admitido por el punto de conexión de token de este servidor de autorización. Los valores posibles son Basic o Body. Cuando se especifica Body, las credenciales de cliente y otros parámetros se pasan dentro del cuerpo de la solicitud en el formato application/x-www-form-urlencoded. Matriz de cadenas que contiene cualquiera de:
"Básico"
'Cuerpo'
clientId Identificador de cliente o aplicación registrado con este servidor de autorización. string (obligatorio)
clientRegistrationEndpoint Referencia opcional a una página donde se realiza el registro de cliente o aplicación para este servidor de autorización. Contiene la dirección URL absoluta a la entidad a la que se hace referencia. string (obligatorio)
clientSecret Secreto de cliente o aplicación registrado con este servidor de autorización. ¡Esta propiedad no se rellenará en las operaciones 'GET'! Use la solicitud POST "/listSecrets" para obtener el valor. cuerda

Restricciones:
Valor confidencial. Pase como parámetro seguro.
defaultScope El ámbito del token de acceso que se va a solicitar de forma predeterminada. Se puede invalidar en el nivel de API. Debe proporcionarse en forma de una cadena que contenga valores delimitados por espacio. cuerda
descripción Descripción del servidor de autorización. Puede contener etiquetas de formato HTML. cuerda
displayName Nombre del servidor de autorización fácil de usar. cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1 (obligatorio)
grantTypes Formulario de una concesión de autorización, que el cliente usa para solicitar el token de acceso. Matriz de cadenas que contiene cualquiera de:
'authorizationCode'
'clientCredentials'
'implícito'
'resourceOwnerPassword' (obligatorio)
resourceOwnerPassword Opcionalmente, se puede especificar cuando este servidor de autorización admite el tipo de concesión de contraseña del propietario del recurso. Contraseña predeterminada del propietario del recurso. cuerda
resourceOwnerUsername Opcionalmente, se puede especificar cuando este servidor de autorización admite el tipo de concesión de contraseña del propietario del recurso. Nombre de usuario del propietario del recurso predeterminado. cuerda
supportState Si es true, el servidor de autorización incluirá el parámetro de estado de la solicitud de autorización a su respuesta. El cliente puede usar el parámetro de estado para aumentar la seguridad del protocolo. Bool
tokenBodyParameters Parámetros adicionales requeridos por el punto de conexión de token de este servidor de autorización representado como una matriz de objetos JSON con propiedades de cadena de nombre y valor, es decir, {"name" : "name value", "value": "a value"}. tokenBodyParameterContract[]
tokenEndpoint Punto de conexión del token de OAuth. Contiene un URI absoluto a la entidad a la que se hace referencia. cuerda

Microsoft.ApiManagement/service/authorizationServers

Nombre Descripción Valor
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1
Patrón = ^[^*#&+:<>?]+$ (obligatorio)
padre En Bicep, puede especificar el recurso primario para un recurso secundario. Solo tiene que agregar esta propiedad cuando el recurso secundario se declara fuera del recurso primario.

Para obtener más información, consulte recurso secundario fuera del recurso primario.		 Nombre simbólico del recurso de tipo: de servicio de
Propiedades Propiedades del contrato externo del servidor de autorización de OAuth. AuthorizationServerContractProperties

TokenBodyParameterContract

Nombre Descripción Valor
nombre nombre del parámetro body. string (obligatorio)
valor valor del parámetro body. string (obligatorio)

Definición de recursos de plantilla de ARM

El tipo de recurso service/authorizationServers se puede implementar con operaciones que tienen como destino:

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.ApiManagement/service/authorizationServers, agregue el siguiente JSON a la plantilla.

{
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "apiVersion": "2021-12-01-preview",
  "name": "string",
  "properties": {
    "authorizationEndpoint": "string",
    "authorizationMethods": [ "string" ],
    "bearerTokenSendingMethods": [ "string" ],
    "clientAuthenticationMethod": [ "string" ],
    "clientId": "string",
    "clientRegistrationEndpoint": "string",
    "clientSecret": "string",
    "defaultScope": "string",
    "description": "string",
    "displayName": "string",
    "grantTypes": [ "string" ],
    "resourceOwnerPassword": "string",
    "resourceOwnerUsername": "string",
    "supportState": "bool",
    "tokenBodyParameters": [
      {
        "name": "string",
        "value": "string"
      }
    ],
    "tokenEndpoint": "string"
  }
}

Valores de propiedad

AuthorizationServerContractProperties

Nombre Descripción Valor
authorizationEndpoint Punto de conexión de autorización de OAuth. Consulte http://tools.ietf.org/html/rfc6749#section-3.2. string (obligatorio)
authorizationMethods Verbos HTTP admitidos por el punto de conexión de autorización. GET debe estar siempre presente. POST es opcional. Matriz de cadenas que contiene cualquiera de:
'DELETE'
'GET'
'HEAD'
'OPTIONS'
'PATCH'
'POST'
'PUT'
'TRACE'
bearerTokenSendingMethods Especifica el mecanismo por el que se pasa el token de acceso a la API. Matriz de cadenas que contiene cualquiera de:
'authorizationHeader'
'query'
clientAuthenticationMethod Método de autenticación admitido por el punto de conexión de token de este servidor de autorización. Los valores posibles son Basic o Body. Cuando se especifica Body, las credenciales de cliente y otros parámetros se pasan dentro del cuerpo de la solicitud en el formato application/x-www-form-urlencoded. Matriz de cadenas que contiene cualquiera de:
"Básico"
'Cuerpo'
clientId Identificador de cliente o aplicación registrado con este servidor de autorización. string (obligatorio)
clientRegistrationEndpoint Referencia opcional a una página donde se realiza el registro de cliente o aplicación para este servidor de autorización. Contiene la dirección URL absoluta a la entidad a la que se hace referencia. string (obligatorio)
clientSecret Secreto de cliente o aplicación registrado con este servidor de autorización. ¡Esta propiedad no se rellenará en las operaciones 'GET'! Use la solicitud POST "/listSecrets" para obtener el valor. cuerda

Restricciones:
Valor confidencial. Pase como parámetro seguro.
defaultScope El ámbito del token de acceso que se va a solicitar de forma predeterminada. Se puede invalidar en el nivel de API. Debe proporcionarse en forma de una cadena que contenga valores delimitados por espacio. cuerda
descripción Descripción del servidor de autorización. Puede contener etiquetas de formato HTML. cuerda
displayName Nombre del servidor de autorización fácil de usar. cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1 (obligatorio)
grantTypes Formulario de una concesión de autorización, que el cliente usa para solicitar el token de acceso. Matriz de cadenas que contiene cualquiera de:
'authorizationCode'
'clientCredentials'
'implícito'
'resourceOwnerPassword' (obligatorio)
resourceOwnerPassword Opcionalmente, se puede especificar cuando este servidor de autorización admite el tipo de concesión de contraseña del propietario del recurso. Contraseña predeterminada del propietario del recurso. cuerda
resourceOwnerUsername Opcionalmente, se puede especificar cuando este servidor de autorización admite el tipo de concesión de contraseña del propietario del recurso. Nombre de usuario del propietario del recurso predeterminado. cuerda
supportState Si es true, el servidor de autorización incluirá el parámetro de estado de la solicitud de autorización a su respuesta. El cliente puede usar el parámetro de estado para aumentar la seguridad del protocolo. Bool
tokenBodyParameters Parámetros adicionales requeridos por el punto de conexión de token de este servidor de autorización representado como una matriz de objetos JSON con propiedades de cadena de nombre y valor, es decir, {"name" : "name value", "value": "a value"}. tokenBodyParameterContract[]
tokenEndpoint Punto de conexión del token de OAuth. Contiene un URI absoluto a la entidad a la que se hace referencia. cuerda

Microsoft.ApiManagement/service/authorizationServers

Nombre Descripción Valor
apiVersion La versión de api '2021-12-01-preview'
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1
Patrón = ^[^*#&+:<>?]+$ (obligatorio)
Propiedades Propiedades del contrato externo del servidor de autorización de OAuth. AuthorizationServerContractProperties
tipo El tipo de recurso "Microsoft.ApiManagement/service/authorizationServers"

TokenBodyParameterContract

Nombre Descripción Valor
nombre nombre del parámetro body. string (obligatorio)
valor valor del parámetro body. string (obligatorio)

Definición de recursos de Terraform (proveedor AzAPI)

El tipo de recurso service/authorizationServers se puede implementar con operaciones que tienen como destino:

  • grupos de recursos de

Para obtener una lista de las propiedades modificadas en cada versión de API, consulte registro de cambios.

Formato de recurso

Para crear un recurso Microsoft.ApiManagement/service/authorizationServers, agregue el siguiente terraform a la plantilla.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/authorizationServers@2021-12-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      authorizationEndpoint = "string"
      authorizationMethods = [
        "string"
      ]
      bearerTokenSendingMethods = [
        "string"
      ]
      clientAuthenticationMethod = [
        "string"
      ]
      clientId = "string"
      clientRegistrationEndpoint = "string"
      clientSecret = "string"
      defaultScope = "string"
      description = "string"
      displayName = "string"
      grantTypes = [
        "string"
      ]
      resourceOwnerPassword = "string"
      resourceOwnerUsername = "string"
      supportState = bool
      tokenBodyParameters = [
        {
          name = "string"
          value = "string"
        }
      ]
      tokenEndpoint = "string"
    }
  })
}

Valores de propiedad

AuthorizationServerContractProperties

Nombre Descripción Valor
authorizationEndpoint Punto de conexión de autorización de OAuth. Consulte http://tools.ietf.org/html/rfc6749#section-3.2. string (obligatorio)
authorizationMethods Verbos HTTP admitidos por el punto de conexión de autorización. GET debe estar siempre presente. POST es opcional. Matriz de cadenas que contiene cualquiera de:
'DELETE'
'GET'
'HEAD'
'OPTIONS'
'PATCH'
'POST'
'PUT'
'TRACE'
bearerTokenSendingMethods Especifica el mecanismo por el que se pasa el token de acceso a la API. Matriz de cadenas que contiene cualquiera de:
'authorizationHeader'
'query'
clientAuthenticationMethod Método de autenticación admitido por el punto de conexión de token de este servidor de autorización. Los valores posibles son Basic o Body. Cuando se especifica Body, las credenciales de cliente y otros parámetros se pasan dentro del cuerpo de la solicitud en el formato application/x-www-form-urlencoded. Matriz de cadenas que contiene cualquiera de:
"Básico"
'Cuerpo'
clientId Identificador de cliente o aplicación registrado con este servidor de autorización. string (obligatorio)
clientRegistrationEndpoint Referencia opcional a una página donde se realiza el registro de cliente o aplicación para este servidor de autorización. Contiene la dirección URL absoluta a la entidad a la que se hace referencia. string (obligatorio)
clientSecret Secreto de cliente o aplicación registrado con este servidor de autorización. ¡Esta propiedad no se rellenará en las operaciones 'GET'! Use la solicitud POST "/listSecrets" para obtener el valor. cuerda

Restricciones:
Valor confidencial. Pase como parámetro seguro.
defaultScope El ámbito del token de acceso que se va a solicitar de forma predeterminada. Se puede invalidar en el nivel de API. Debe proporcionarse en forma de una cadena que contenga valores delimitados por espacio. cuerda
descripción Descripción del servidor de autorización. Puede contener etiquetas de formato HTML. cuerda
displayName Nombre del servidor de autorización fácil de usar. cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1 (obligatorio)
grantTypes Formulario de una concesión de autorización, que el cliente usa para solicitar el token de acceso. Matriz de cadenas que contiene cualquiera de:
'authorizationCode'
'clientCredentials'
'implícito'
'resourceOwnerPassword' (obligatorio)
resourceOwnerPassword Opcionalmente, se puede especificar cuando este servidor de autorización admite el tipo de concesión de contraseña del propietario del recurso. Contraseña predeterminada del propietario del recurso. cuerda
resourceOwnerUsername Opcionalmente, se puede especificar cuando este servidor de autorización admite el tipo de concesión de contraseña del propietario del recurso. Nombre de usuario del propietario del recurso predeterminado. cuerda
supportState Si es true, el servidor de autorización incluirá el parámetro de estado de la solicitud de autorización a su respuesta. El cliente puede usar el parámetro de estado para aumentar la seguridad del protocolo. Bool
tokenBodyParameters Parámetros adicionales requeridos por el punto de conexión de token de este servidor de autorización representado como una matriz de objetos JSON con propiedades de cadena de nombre y valor, es decir, {"name" : "name value", "value": "a value"}. tokenBodyParameterContract[]
tokenEndpoint Punto de conexión del token de OAuth. Contiene un URI absoluto a la entidad a la que se hace referencia. cuerda

Microsoft.ApiManagement/service/authorizationServers

Nombre Descripción Valor
nombre El nombre del recurso cuerda

Restricciones:
Longitud mínima = 1
Longitud máxima = 1
Patrón = ^[^*#&+:<>?]+$ (obligatorio)
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: de servicio de
Propiedades Propiedades del contrato externo del servidor de autorización de OAuth. AuthorizationServerContractProperties
tipo El tipo de recurso "Microsoft.ApiManagement/service/authorizationServers@2021-12-01-preview"

TokenBodyParameterContract

Nombre Descripción Valor
nombre nombre del parámetro body. string (obligatorio)
valor valor del parámetro body. string (obligatorio)