OpenId Connect Provider - List By Service
Tüm OpenId Connect Sağlayıcılarının listesi.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders?api-version=2022-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2022-08-01
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
resource
|
path | True |
string |
Kaynak grubunun adı. Ad büyük/küçük harfe duyarlı değildir. |
service
|
path | True |
string |
API Management hizmetinin adı. Regex pattern: |
subscription
|
path | True |
string |
Hedef aboneliğin kimliği. |
api-version
|
query | True |
string |
Bu işlem için kullanılacak API sürümü. |
$filter
|
query |
string |
| Alan | Kullanım | Desteklenen işleçler | Desteklenen işlevler | |
|
$skip
|
query |
integer int32 |
At edilecek kayıt sayısı. |
|
$top
|
query |
integer int32 |
Döndürülecek kayıt sayısı. |
Yanıtlar
Name | Tür | Description |
---|---|---|
200 OK |
Tüm OpenId Connect Sağlayıcılarının listesi. |
|
Other Status Codes |
İşlemin neden başarısız olduğunu açıklayan hata yanıtı. |
Güvenlik
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | kullanıcı hesabınızın kimliğine bürünme |
Örnekler
ApiManagementListOpenIdConnectProviders
Sample Request
GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders?api-version=2022-08-01
Sample Response
{
"value": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect2",
"type": "Microsoft.ApiManagement/service/openidconnectproviders",
"name": "templateOpenIdConnect2",
"properties": {
"displayName": "templateoidprovider2",
"description": "open id provider template2",
"metadataEndpoint": "https://oidprovider-template2.net",
"clientId": "oidprovidertemplate2",
"useInTestConsole": false,
"useInApiDocumentation": true
}
}
],
"count": 1,
"nextLink": ""
}
Tanımlar
Name | Description |
---|---|
Error |
Hata Alanı sözleşmesi. |
Error |
Hata Yanıtı. |
Open |
Paged OpenIdProviders liste gösterimi. |
Openid |
OpenId Connect Sağlayıcısı ayrıntıları. |
ErrorFieldContract
Hata Alanı sözleşmesi.
Name | Tür | Description |
---|---|---|
code |
string |
Özellik düzeyi hata kodu. |
message |
string |
Özellik düzeyi hatanın insan tarafından okunabilir gösterimi. |
target |
string |
Özellik adı. |
ErrorResponse
Hata Yanıtı.
Name | Tür | Description |
---|---|---|
error.code |
string |
Hizmet tanımlı hata kodu. Bu kod, yanıtta belirtilen HTTP hata kodu için bir alt durum görevi görür. |
error.details |
Doğrulama hatası durumunda istekte gönderilen geçersiz alanların listesi. |
|
error.message |
string |
Hatanın insan tarafından okunabilen gösterimi. |
OpenIdConnectProviderCollection
Paged OpenIdProviders liste gösterimi.
Name | Tür | Description |
---|---|---|
count |
integer |
Tüm sayfalardaki toplam kayıt sayısı. |
nextLink |
string |
Varsa sonraki sayfa bağlantısı. |
value |
Sayfa değerleri. |
OpenidConnectProviderContract
OpenId Connect Sağlayıcısı ayrıntıları.
Name | Tür | Description |
---|---|---|
id |
string |
Kaynağın tam kaynak kimliği. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
Kaynağın adı |
properties.clientId |
string |
İstemci uygulaması olan geliştirici konsolunun istemci kimliği. |
properties.clientSecret |
string |
İstemci uygulaması olan geliştirici konsolunun gizli anahtarı. |
properties.description |
string |
OpenID Connect Sağlayıcısının kullanıcı dostu açıklaması. |
properties.displayName |
string |
Kullanıcı dostu OpenID Connect Sağlayıcısı adı. |
properties.metadataEndpoint |
string |
Meta veri uç noktası URI'si. |
properties.useInApiDocumentation |
boolean |
True ise, Open ID Connect sağlayıcısı geliştirici portalındaki API belgelerinde kullanılır. Değer sağlanmazsa varsayılan olarak false olur. |
properties.useInTestConsole |
boolean |
Doğruysa, Open ID Connect sağlayıcısı geliştirici portalı test konsolunda kullanılabilir. Değer sağlanmazsa varsayılan olarak True olur. |
type |
string |
Kaynağın türü. Örneğin, "Microsoft.Compute/virtualMachines" veya "Microsoft.Storage/storageAccounts" |