Compartir a través de

Servicio Microsoft.ApiManagement/authorizationServers 2023-03-01-preview

  • Artículo

Definición de recursos de Bicep

El tipo de recurso service/authorizationServers se puede implementar con operaciones destinadas a:

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

Formato de los recursos

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

resource symbolicname 'Microsoft.ApiManagement/service/authorizationServers@2023-03-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  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'
    useInApiDocumentation: bool
    useInTestConsole: bool
  }
}

Valores de propiedad

service/authorizationServers

Nombre Descripción Value
name El nombre del recurso

Vea cómo establecer nombres y tipos para recursos secundarios en Bicep.		 string (obligatorio)

Límite de caracteres: 1-80

Caracteres válidos:
Caracteres alfanuméricos y guiones.

Comience con una letra y termine con un carácter alfanumérico.
primario 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 más información, consulte Recurso secundario fuera del recurso primario.		 Nombre simbólico del recurso de tipo: servicio
properties Propiedades del contrato externo del servidor de autorización de OAuth. AuthorizationServerContractProperties

AuthorizationServerContractProperties

Nombre Descripción Valor
authorizationEndpoint Extremo de autorización OAuth. Consulta 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 el token de acceso pasa a la API. Matriz de cadenas que contiene cualquiera de:
'authorizationHeader'
'query'
clientAuthenticationMethod Método de autenticación admitido por el extremo 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 del cliente o la aplicación para este servidor de autorización. Contiene la dirección URL absoluta de 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. string
defaultScope Ámbito de token de acceso que se va a solicitar de manera predeterminada. Se puede reemplazar en el nivel de API. Debe proporcionarse en forma de cadena que contiene los valores delimitados por espacios. string
description Descripción del servidor de autorización. Puede contener etiquetas de formato HTML. string
DisplayName Nombre del servidor de autorización descriptivo. string (obligatorio)
grantTypes Forma 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"
'implicit'
'resourceOwnerPassword' (obligatorio)
resourceOwnerPassword Se puede especificar también cuando este servidor de autorización admite el tipo de concesión de contraseña de propietario de recursos. Contraseña de usuario de propietario de recursos predeterminada. string
resourceOwnerUsername Se puede especificar también cuando este servidor de autorización admite el tipo de concesión de contraseña de propietario de recursos. Nombre de usuario de propietario de recursos predeterminado. string
supportState Si es true, el servidor de autorización incluirá el parámetro state de la solicitud de autorización a su respuesta. El cliente puede utilizar el parámetro de estado para incrementar la seguridad de 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 Extremo de token OAuth. Contiene el URI absoluto de la entidad a la que se hace referencia. string
useInApiDocumentation Si es true, el servidor de autorización se usará en la documentación de la API del portal para desarrolladores. False de forma predeterminada si no se proporciona ningún valor. bool
useInTestConsole Si es true, el servidor de autorización se puede usar en la consola de prueba del portal para desarrolladores. True de forma predeterminada si no se proporciona ningún valor. bool

TokenBodyParameterContract

Nombre Descripción Value
name nombre del parámetro body. string (obligatorio)
value 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 los recursos

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

{
  "type": "Microsoft.ApiManagement/service/authorizationServers",
  "apiVersion": "2023-03-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",
    "useInApiDocumentation": "bool",
    "useInTestConsole": "bool"
  }
}

Valores de propiedad

service/authorizationServers

Nombre Descripción Value
type Tipo de recurso "Microsoft.ApiManagement/service/authorizationServers"
apiVersion La versión de la API de recursos "2023-03-01-preview"
name El nombre del recurso

Consulte cómo establecer nombres y tipos para recursos secundarios en plantillas de ARM json.		 string (obligatorio)

Límite de caracteres: 1-80

Caracteres válidos:
Caracteres alfanuméricos y guiones.

Comience con una letra y termine con un carácter alfanumérico.
properties Propiedades del contrato externo del servidor de autorización de OAuth. AuthorizationServerContractProperties

AuthorizationServerContractProperties

Nombre Descripción Valor
authorizationEndpoint Extremo de autorización OAuth. Consulta 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 el token de acceso pasa a la API. Matriz de cadenas que contiene cualquiera de:
'authorizationHeader'
'query'
clientAuthenticationMethod Método de autenticación admitido por el extremo 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 del cliente o la aplicación para este servidor de autorización. Contiene la dirección URL absoluta de 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. string
defaultScope Ámbito de token de acceso que se va a solicitar de manera predeterminada. Se puede reemplazar en el nivel de API. Debe proporcionarse en forma de cadena que contiene los valores delimitados por espacios. string
description Descripción del servidor de autorización. Puede contener etiquetas de formato HTML. string
DisplayName Nombre del servidor de autorización descriptivo. string (obligatorio)
grantTypes Forma 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 Se puede especificar también cuando este servidor de autorización admite el tipo de concesión de contraseña de propietario de recursos. Contraseña de usuario de propietario de recursos predeterminada. string
resourceOwnerUsername Se puede especificar también cuando este servidor de autorización admite el tipo de concesión de contraseña de propietario de recursos. Nombre de usuario de propietario de recursos predeterminado. string
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 utilizar el parámetro de estado para incrementar la seguridad de 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 Extremo de token OAuth. Contiene el URI absoluto de la entidad a la que se hace referencia. string
useInApiDocumentation Si es true, el servidor de autorización se usará en la documentación de la API en el portal para desarrolladores. False de forma predeterminada si no se proporciona ningún valor. bool
useInTestConsole Si es true, el servidor de autorización se puede usar en la consola de prueba del portal para desarrolladores. True de forma predeterminada si no se proporciona ningún valor. bool

TokenBodyParameterContract

Nombre Descripción Value
name nombre del parámetro body. string (obligatorio)
value 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 destinadas a:

  • Grupos de recursos

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

Formato de los recursos

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/authorizationServers@2023-03-01-preview"
  name = "string"
  parent_id = "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"
      useInApiDocumentation = bool
      useInTestConsole = bool
    }
  })
}

Valores de propiedad

service/authorizationServers

Nombre Descripción Value
type Tipo de recurso "Microsoft.ApiManagement/service/authorizationServers@2023-03-01-preview"
name El nombre del recurso string (obligatorio)

Límite de caracteres: 1-80

Caracteres válidos:
Caracteres alfanuméricos y guiones.

Comience con una letra y termine con un carácter alfanumérico.
parent_id Identificador del recurso que es el elemento primario de este recurso. Identificador del recurso de tipo: servicio
properties Propiedades del contrato externo del servidor de autorización de OAuth. AuthorizationServerContractProperties

AuthorizationServerContractProperties

Nombre Descripción Valor
authorizationEndpoint Extremo de autorización OAuth. Consulta 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"
"OPCIONES"
"PATCH"
"POST"
"PUT"
"TRACE"
bearerTokenSendingMethods Especifica el mecanismo por el que el token de acceso pasa a la API. Matriz de cadenas que contiene cualquiera de:
"authorizationHeader"
"query"
clientAuthenticationMethod Método de autenticación admitido por el extremo 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ásica"
"Body" (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 del cliente o la aplicación para este servidor de autorización. Contiene la dirección URL absoluta de 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. string
defaultScope Ámbito de token de acceso que se va a solicitar de manera predeterminada. Se puede reemplazar en el nivel de API. Debe proporcionarse en forma de cadena que contiene los valores delimitados por espacios. string
description Descripción del servidor de autorización. Puede contener etiquetas de formato HTML. string
DisplayName Nombre del servidor de autorización descriptivo. string (obligatorio)
grantTypes Forma 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 Se puede especificar también cuando este servidor de autorización admite el tipo de concesión de contraseña de propietario de recursos. Contraseña de usuario de propietario de recursos predeterminada. string
resourceOwnerUsername Se puede especificar también cuando este servidor de autorización admite el tipo de concesión de contraseña de propietario de recursos. Nombre de usuario de propietario de recursos predeterminado. string
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 utilizar el parámetro de estado para incrementar la seguridad de 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 Extremo de token OAuth. Contiene el URI absoluto de la entidad a la que se hace referencia. string
useInApiDocumentation Si es true, el servidor de autorización se usará en la documentación de la API en el portal para desarrolladores. False de forma predeterminada si no se proporciona ningún valor. bool
useInTestConsole Si es true, el servidor de autorización se puede usar en la consola de prueba del portal para desarrolladores. True de forma predeterminada si no se proporciona ningún valor. bool

TokenBodyParameterContract

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