OpenId Connect Provider - Create Or Update

Hizmet:

API Management

API Sürümü:

2024-05-01

OpenID Connect Sağlayıcısını oluşturur veya güncelleştirir.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders/{opid}?api-version=2024-05-01

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
opid	path	True	string maxLength: 256 pattern: ^[^*#&+:<>?]+$	OpenID Connect Sağlayıcısının tanımlayıcısı.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Kaynak grubunun adı. Ad büyük/küçük harfe duyarsız.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API Management hizmetinin adı.
subscriptionId	path	True	string (uuid)	Hedef aboneliğin kimliği. Değer bir UUID olmalıdır.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Gerekli	Tür	Description
If-Match		string	Varlığın ETag'i. Varlık oluştururken gerekli değildir, ancak varlığı güncelleştirirken gereklidir.

İstek Gövdesi

Name	Gerekli	Tür	Description
properties.clientId	True	string	İstemci uygulaması olan geliştirici konsolunun istemci kimliği.
properties.displayName	True	string maxLength: 50	Kullanıcı dostu OpenID Connect Sağlayıcısı adı.
properties.metadataEndpoint	True	string	Meta veri uç noktası URI'si.
properties.clientSecret		string	İstemci uygulaması olan geliştirici konsolunun İstemci Gizli Anahtarı.
properties.description		string	OpenID Connect Sağlayıcısının kullanıcı dostu açıklaması.
properties.useInApiDocumentation		boolean	Doğruysa, 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.

Yanıtlar

Name	Tür	Description
200 OK	OpenidConnectProviderContract	OpenIdConnect Sağlayıcısı başarıyla güncelleştirildi. Üst Bilgiler ETag: string
201 Created	OpenidConnectProviderContract	OpenIdConnect Sağlayıcısı başarıyla oluşturuldu. Üst Bilgiler ETag: string
Other Status Codes	ErrorResponse	İşlemin neden başarısız olduğunu açıklayan hata yanıtı.

Güvenlik

azure_auth

Azure Active Directory OAuth2 Akışı.

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/authorize

Kapsamlar

Name	Description
user_impersonation	kullanıcı hesabınızın kimliğine bürünme

Örnekler

ApiManagementCreateOpenIdConnectProvider

Örnek isteği

HTTP

PUT https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect3?api-version=2024-05-01

{
  "properties": {
    "displayName": "templateoidprovider3",
    "metadataEndpoint": "https://example.com",
    "clientId": "oidprovidertemplate3",
    "clientSecret": "x",
    "useInTestConsole": false,
    "useInApiDocumentation": true
  }
}

Java

/**
 * Samples for OpenIdConnectProvider CreateOrUpdate.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/
     * ApiManagementCreateOpenIdConnectProvider.json
     */
    /**
     * Sample code: ApiManagementCreateOpenIdConnectProvider.
     * 
     * @param manager Entry point to ApiManagementManager.
     */
    public static void
        apiManagementCreateOpenIdConnectProvider(com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager.openIdConnectProviders().define("templateOpenIdConnect3").withExistingService("rg1", "apimService1")
            .withDisplayName("templateoidprovider3").withMetadataEndpoint("https://oidprovider-template3.net")
            .withClientId("oidprovidertemplate3").withClientSecret("x").withUseInTestConsole(false)
            .withUseInApiDocumentation(true).create();
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_create_open_id_connect_provider.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = ApiManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.open_id_connect_provider.create_or_update(
        resource_group_name="rg1",
        service_name="apimService1",
        opid="templateOpenIdConnect3",
        parameters={
            "properties": {
                "clientId": "oidprovidertemplate3",
                "clientSecret": "x",
                "displayName": "templateoidprovider3",
                "metadataEndpoint": "https://oidprovider-template3.net",
                "useInApiDocumentation": True,
                "useInTestConsole": False,
            }
        },
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementCreateOpenIdConnectProvider.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armapimanagement_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/apimanagement/armapimanagement/v3"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/e436160e64c0f8d7fb20d662be2712f71f0a7ef5/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementCreateOpenIdConnectProvider.json
func ExampleOpenIDConnectProviderClient_CreateOrUpdate() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armapimanagement.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewOpenIDConnectProviderClient().CreateOrUpdate(ctx, "rg1", "apimService1", "templateOpenIdConnect3", armapimanagement.OpenidConnectProviderContract{
		Properties: &armapimanagement.OpenidConnectProviderContractProperties{
			ClientID:              to.Ptr("oidprovidertemplate3"),
			ClientSecret:          to.Ptr("x"),
			DisplayName:           to.Ptr("templateoidprovider3"),
			MetadataEndpoint:      to.Ptr("https://oidprovider-template3.net"),
			UseInAPIDocumentation: to.Ptr(true),
			UseInTestConsole:      to.Ptr(false),
		},
	}, &armapimanagement.OpenIDConnectProviderClientCreateOrUpdateOptions{IfMatch: nil})
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.OpenidConnectProviderContract = armapimanagement.OpenidConnectProviderContract{
	// 	Name: to.Ptr("templateOpenIdConnect3"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/openidconnectproviders"),
	// 	ID: to.Ptr("/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect3"),
	// 	Properties: &armapimanagement.OpenidConnectProviderContractProperties{
	// 		ClientID: to.Ptr("oidprovidertemplate3"),
	// 		DisplayName: to.Ptr("templateoidprovider3"),
	// 		MetadataEndpoint: to.Ptr("https://oidprovider-template3.net"),
	// 		UseInAPIDocumentation: to.Ptr(true),
	// 		UseInTestConsole: to.Ptr(false),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ApiManagementClient } = require("@azure/arm-apimanagement");
const { DefaultAzureCredential } = require("@azure/identity");
require("dotenv/config");

/**
 * This sample demonstrates how to Creates or updates the OpenID Connect Provider.
 *
 * @summary Creates or updates the OpenID Connect Provider.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementCreateOpenIdConnectProvider.json
 */
async function apiManagementCreateOpenIdConnectProvider() {
  const subscriptionId =
    process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const opid = "templateOpenIdConnect3";
  const parameters = {
    clientId: "oidprovidertemplate3",
    clientSecret: "x",
    displayName: "templateoidprovider3",
    metadataEndpoint: "https://oidprovider-template3.net",
    useInApiDocumentation: true,
    useInTestConsole: false,
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.openIdConnectProvider.createOrUpdate(
    resourceGroupName,
    serviceName,
    opid,
    parameters,
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ApiManagement;

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2024-05-01/examples/ApiManagementCreateOpenIdConnectProvider.json
// this example is just showing the usage of "OpenIdConnectProvider_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ApiManagementServiceResource created on azure
// for more information of creating ApiManagementServiceResource, please refer to the document of ApiManagementServiceResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// get the collection of this ApiManagementOpenIdConnectProviderResource
ApiManagementOpenIdConnectProviderCollection collection = apiManagementService.GetApiManagementOpenIdConnectProviders();

// invoke the operation
string openId = "templateOpenIdConnect3";
ApiManagementOpenIdConnectProviderData data = new ApiManagementOpenIdConnectProviderData
{
    DisplayName = "templateoidprovider3",
    MetadataEndpoint = "https://oidprovider-template3.net",
    ClientId = "oidprovidertemplate3",
    ClientSecret = "x",
    UseInTestConsole = false,
    UseInApiDocumentation = true,
};
ArmOperation<ApiManagementOpenIdConnectProviderResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, openId, data);
ApiManagementOpenIdConnectProviderResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
ApiManagementOpenIdConnectProviderData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Örnek yanıt

Durum kodu:

201

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect3",
  "type": "Microsoft.ApiManagement/service/openidconnectproviders",
  "name": "templateOpenIdConnect3",
  "properties": {
    "displayName": "templateoidprovider3",
    "metadataEndpoint": "https://example.com",
    "clientId": "oidprovidertemplate3",
    "useInTestConsole": false,
    "useInApiDocumentation": true
  }
}

Durum kodu:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect3",
  "type": "Microsoft.ApiManagement/service/openidconnectproviders",
  "name": "templateOpenIdConnect3",
  "properties": {
    "displayName": "templateoidprovider3",
    "metadataEndpoint": "https://example.com",
    "clientId": "oidprovidertemplate3",
    "useInTestConsole": false,
    "useInApiDocumentation": true
  }
}

Tanımlar

Name	Description
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
OpenidConnectProviderContract	OpenId Connect Sağlayıcısı ayrıntıları.

ErrorAdditionalInfo

Object

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Object

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Object

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

OpenidConnectProviderContract

Object

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 İstemci Gizli Anahtarı.
properties.description	string	OpenID Connect Sağlayıcısının kullanıcı dostu açıklaması.
properties.displayName	string maxLength: 50	Kullanıcı dostu OpenID Connect Sağlayıcısı adı.
properties.metadataEndpoint	string	Meta veri uç noktası URI'si.
properties.useInApiDocumentation	boolean	Doğruysa, 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"