Microsoft.ApiManagement service/openidConnectProviders 2023-09-01-preview
- najnowsze
- 2024-06-01-preview
- 2024-05-01
- 2023-09-01-preview
- 2023-05-01-preview
- 2023-03-01-preview
- 2022-09-01-preview
- 2022-08-01
- 2022-04-01-preview
- 2021-12-01-preview
- 2021-08-01
- 2021-04-01-preview
- 2021-01-01-preview
- 2020-12-01
- 2020-06-01-preview
- 2019-12-01
- 2019-12-01-preview
- 2019-01-01
- 2018-06-01-preview
- 2018-01-01
- 2017-03-01
- 2016-10-10
- 2016-07-07
Definicja zasobu Bicep
Typ zasobu service/openidConnectProviders można wdrożyć za pomocą operacji docelowych:
- grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.ApiManagement/service/openidConnectProviders, dodaj następujący kod Bicep do szablonu.
resource symbolicname 'Microsoft.ApiManagement/service/openidConnectProviders@2023-09-01-preview' = {
parent: resourceSymbolicName
name: 'string'
properties: {
clientId: 'string'
clientSecret: 'string'
description: 'string'
displayName: 'string'
metadataEndpoint: 'string'
useInApiDocumentation: bool
useInTestConsole: bool
}
}
Wartości właściwości
Microsoft.ApiManagement/service/openidConnectProviders
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa | Nazwa zasobu | struna Ograniczenia: Maksymalna długość = 256 Wzorzec = ^[^*#&+:<>?]+$ (wymagane) |
| rodzic | W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym. Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym. |
Nazwa symboliczna zasobu typu: usługi |
| Właściwości | Właściwości kontraktu openId Connect Provider. | OpenidConnectProviderContractProperties |
OpenidConnectProviderContractProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| clientId | Identyfikator klienta konsoli dewelopera, która jest aplikacją kliencka. | ciąg (wymagany) |
| clientSecret | Klucz tajny klienta konsoli dewelopera, która jest aplikacją kliencka. | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
| opis | Przyjazny dla użytkownika opis dostawcy OpenID Connect. | struna |
| displayName | Przyjazna dla użytkownika nazwa dostawcy openID Connect. | struna Ograniczenia: Maksymalna długość = 50 (wymagane) |
| metadataEndpoint | Identyfikator URI punktu końcowego metadanych. | ciąg (wymagany) |
| useInApiDocumentation | Jeśli to prawda, dostawca Open ID Connect będzie używany w dokumentacji interfejsu API w portalu dla deweloperów. Wartość false domyślnie, jeśli nie podano żadnej wartości. | Bool |
| useInTestConsole | Jeśli to prawda, dostawca Open ID Connect może być używany w konsoli testowej portalu deweloperów. Wartość true domyślnie, jeśli nie podano żadnej wartości. | Bool |
Definicja zasobu szablonu usługi ARM
Typ zasobu service/openidConnectProviders można wdrożyć za pomocą operacji docelowych:
- grupy zasobów — zobacz polecenia wdrażania grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.ApiManagement/service/openidConnectProviders, dodaj następujący kod JSON do szablonu.
{
"type": "Microsoft.ApiManagement/service/openidConnectProviders",
"apiVersion": "2023-09-01-preview",
"name": "string",
"properties": {
"clientId": "string",
"clientSecret": "string",
"description": "string",
"displayName": "string",
"metadataEndpoint": "string",
"useInApiDocumentation": "bool",
"useInTestConsole": "bool"
}
}
Wartości właściwości
Microsoft.ApiManagement/service/openidConnectProviders
| Nazwa | Opis | Wartość |
|---|---|---|
| apiVersion | Wersja interfejsu API | "2023-09-01-preview" |
| nazwa | Nazwa zasobu | struna Ograniczenia: Maksymalna długość = 256 Wzorzec = ^[^*#&+:<>?]+$ (wymagane) |
| Właściwości | Właściwości kontraktu openId Connect Provider. | OpenidConnectProviderContractProperties |
| typ | Typ zasobu | "Microsoft.ApiManagement/service/openidConnectProviders" |
OpenidConnectProviderContractProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| clientId | Identyfikator klienta konsoli dewelopera, która jest aplikacją kliencka. | ciąg (wymagany) |
| clientSecret | Klucz tajny klienta konsoli dewelopera, która jest aplikacją kliencka. | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
| opis | Przyjazny dla użytkownika opis dostawcy OpenID Connect. | struna |
| displayName | Przyjazna dla użytkownika nazwa dostawcy openID Connect. | struna Ograniczenia: Maksymalna długość = 50 (wymagane) |
| metadataEndpoint | Identyfikator URI punktu końcowego metadanych. | ciąg (wymagany) |
| useInApiDocumentation | Jeśli to prawda, dostawca Open ID Connect będzie używany w dokumentacji interfejsu API w portalu dla deweloperów. Wartość false domyślnie, jeśli nie podano żadnej wartości. | Bool |
| useInTestConsole | Jeśli to prawda, dostawca Open ID Connect może być używany w konsoli testowej portalu deweloperów. Wartość true domyślnie, jeśli nie podano żadnej wartości. | Bool |
Definicja zasobu narzędzia Terraform (dostawcy AzAPI)
Typ zasobu service/openidConnectProviders można wdrożyć za pomocą operacji docelowych:
- grupy zasobów
Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.
Format zasobu
Aby utworzyć zasób Microsoft.ApiManagement/service/openidConnectProviders, dodaj następujący program Terraform do szablonu.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/openidConnectProviders@2023-09-01-preview"
name = "string"
body = jsonencode({
properties = {
clientId = "string"
clientSecret = "string"
description = "string"
displayName = "string"
metadataEndpoint = "string"
useInApiDocumentation = bool
useInTestConsole = bool
}
})
}
Wartości właściwości
Microsoft.ApiManagement/service/openidConnectProviders
| Nazwa | Opis | Wartość |
|---|---|---|
| nazwa | Nazwa zasobu | struna Ograniczenia: Maksymalna długość = 256 Wzorzec = ^[^*#&+:<>?]+$ (wymagane) |
| parent_id | Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. | Identyfikator zasobu typu: usługi |
| Właściwości | Właściwości kontraktu openId Connect Provider. | OpenidConnectProviderContractProperties |
| typ | Typ zasobu | "Microsoft.ApiManagement/service/openidConnectProviders@2023-09-01-preview" |
OpenidConnectProviderContractProperties
| Nazwa | Opis | Wartość |
|---|---|---|
| clientId | Identyfikator klienta konsoli dewelopera, która jest aplikacją kliencka. | ciąg (wymagany) |
| clientSecret | Klucz tajny klienta konsoli dewelopera, która jest aplikacją kliencka. | struna Ograniczenia: Wartość wrażliwa. Przekaż jako bezpieczny parametr. |
| opis | Przyjazny dla użytkownika opis dostawcy OpenID Connect. | struna |
| displayName | Przyjazna dla użytkownika nazwa dostawcy openID Connect. | struna Ograniczenia: Maksymalna długość = 50 (wymagane) |
| metadataEndpoint | Identyfikator URI punktu końcowego metadanych. | ciąg (wymagany) |
| useInApiDocumentation | Jeśli to prawda, dostawca Open ID Connect będzie używany w dokumentacji interfejsu API w portalu dla deweloperów. Wartość false domyślnie, jeśli nie podano żadnej wartości. | Bool |
| useInTestConsole | Jeśli to prawda, dostawca Open ID Connect może być używany w konsoli testowej portalu deweloperów. Wartość true domyślnie, jeśli nie podano żadnej wartości. | Bool |