Поделиться через


Служба Microsoft.ApiManagement/openidConnectProviders 2023-03-01-preview

Определение ресурсов Bicep

Тип ресурса service/openidConnectProviders можно развернуть с помощью операций, предназначенных для следующих операций:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.ApiManagement/service/openidConnectProviders, добавьте следующий Bicep в шаблон.

resource symbolicname 'Microsoft.ApiManagement/service/openidConnectProviders@2023-03-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    clientId: 'string'
    clientSecret: 'string'
    description: 'string'
    displayName: 'string'
    metadataEndpoint: 'string'
    useInApiDocumentation: bool
    useInTestConsole: bool
  }
}

Значения свойств

Microsoft.ApiManagement/service/openidConnectProviders

Имя Описание Ценность
имя Имя ресурса струна

Ограничения целостности:
Максимальная длина = 256
Pattern = ^[^*#&+:<>?]+$ (обязательно)
родитель В Bicep можно указать родительский ресурс для дочернего ресурса. Это свойство необходимо добавить, только если дочерний ресурс объявлен за пределами родительского ресурса.

Дополнительные сведения см. в разделе Дочерний ресурс за пределами родительского ресурса.
Символьное имя ресурса типа: служба
свойства Свойства контракта поставщика OpenId Connect. OpenidConnectProviderContractProperties

OpenidConnectProviderContractProperties

Имя Описание Ценность
clientId Идентификатор клиента консоли разработчика, являющейся клиентским приложением. строка (обязательно)
clientSecret Секрет клиента консоли разработчика, являющейся клиентским приложением. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
описание Понятное описание поставщика OpenID Connect. струна
displayName Понятное имя поставщика OpenID Connect. струна

Ограничения целостности:
Максимальная длина = 50 (обязательно)
metadataEndpoint URI конечной точки метаданных. строка (обязательно)
useInApiDocumentation Если значение true, поставщик Open ID Connect будет использоваться в документации по API на портале разработчика. Значение false по умолчанию, если значение не указано. bool
useInTestConsole Если значение true, поставщик Open ID Connect может использоваться в тестовой консоли портала разработчика. Значение true по умолчанию, если значение не указано. bool

Определение ресурса шаблона ARM

Тип ресурса service/openidConnectProviders можно развернуть с помощью операций, предназначенных для следующих операций:

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.ApiManagement/service/openidConnectProviders, добавьте следующий код JSON в шаблон.

{
  "type": "Microsoft.ApiManagement/service/openidConnectProviders",
  "apiVersion": "2023-03-01-preview",
  "name": "string",
  "properties": {
    "clientId": "string",
    "clientSecret": "string",
    "description": "string",
    "displayName": "string",
    "metadataEndpoint": "string",
    "useInApiDocumentation": "bool",
    "useInTestConsole": "bool"
  }
}

Значения свойств

Microsoft.ApiManagement/service/openidConnectProviders

Имя Описание Ценность
apiVersion Версия API '2023-03-01-preview'
имя Имя ресурса струна

Ограничения целостности:
Максимальная длина = 256
Pattern = ^[^*#&+:<>?]+$ (обязательно)
свойства Свойства контракта поставщика OpenId Connect. OpenidConnectProviderContractProperties
тип Тип ресурса "Microsoft.ApiManagement/service/openidConnectProviders"

OpenidConnectProviderContractProperties

Имя Описание Ценность
clientId Идентификатор клиента консоли разработчика, являющейся клиентским приложением. строка (обязательно)
clientSecret Секрет клиента консоли разработчика, являющейся клиентским приложением. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
описание Понятное описание поставщика OpenID Connect. струна
displayName Понятное имя поставщика OpenID Connect. струна

Ограничения целостности:
Максимальная длина = 50 (обязательно)
metadataEndpoint URI конечной точки метаданных. строка (обязательно)
useInApiDocumentation Если значение true, поставщик Open ID Connect будет использоваться в документации по API на портале разработчика. Значение false по умолчанию, если значение не указано. bool
useInTestConsole Если значение true, поставщик Open ID Connect может использоваться в тестовой консоли портала разработчика. Значение true по умолчанию, если значение не указано. bool

Определение ресурса Terraform (поставщик AzAPI)

Тип ресурса service/openidConnectProviders можно развернуть с помощью операций, предназначенных для следующих операций:

  • групп ресурсов

Список измененных свойств в каждой версии API см. в журнала изменений.

Формат ресурса

Чтобы создать ресурс Microsoft.ApiManagement/service/openidConnectProviders, добавьте следующий объект Terraform в шаблон.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/openidConnectProviders@2023-03-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      clientId = "string"
      clientSecret = "string"
      description = "string"
      displayName = "string"
      metadataEndpoint = "string"
      useInApiDocumentation = bool
      useInTestConsole = bool
    }
  })
}

Значения свойств

Microsoft.ApiManagement/service/openidConnectProviders

Имя Описание Ценность
имя Имя ресурса струна

Ограничения целостности:
Максимальная длина = 256
Pattern = ^[^*#&+:<>?]+$ (обязательно)
parent_id Идентификатор ресурса, который является родительским для этого ресурса. Идентификатор ресурса типа: службы
свойства Свойства контракта поставщика OpenId Connect. OpenidConnectProviderContractProperties
тип Тип ресурса "Microsoft.ApiManagement/service/openidConnectProviders@2023-03-01-preview"

OpenidConnectProviderContractProperties

Имя Описание Ценность
clientId Идентификатор клиента консоли разработчика, являющейся клиентским приложением. строка (обязательно)
clientSecret Секрет клиента консоли разработчика, являющейся клиентским приложением. струна

Ограничения целостности:
Конфиденциальное значение. Передайте в качестве безопасного параметра.
описание Понятное описание поставщика OpenID Connect. струна
displayName Понятное имя поставщика OpenID Connect. струна

Ограничения целостности:
Максимальная длина = 50 (обязательно)
metadataEndpoint URI конечной точки метаданных. строка (обязательно)
useInApiDocumentation Если значение true, поставщик Open ID Connect будет использоваться в документации по API на портале разработчика. Значение false по умолчанию, если значение не указано. bool
useInTestConsole Если значение true, поставщик Open ID Connect может использоваться в тестовой консоли портала разработчика. Значение true по умолчанию, если значение не указано. bool