Identity Provider - Update

Riferimento

Service:: API Management

API Version:: 2022-08-01

Aggiornamenti una configurazione IdentityProvider esistente.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}?api-version=2022-08-01

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
identityProviderName	path	True	IdentityProviderType	Identificatore del tipo di provider di identità.
resourceGroupName	path	True	string	Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.
serviceName	path	True	string	Nome del servizio Gestione API. Regex pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$`
subscriptionId	path	True	string	ID della sottoscrizione di destinazione.
api-version	query	True	string	Versione dell'API da usare per questa operazione.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
If-Match	True	string	ETag dell'entità. ETag deve corrispondere allo stato dell'entità corrente dalla risposta di intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato.

Corpo della richiesta

Nome	Tipo	Descrizione
properties.allowedTenants	string[]	Elenco dei tenant consentiti durante la configurazione dell'account di accesso di Azure Active Directory.
properties.authority	string	Nome host dell'endpoint di individuazione OpenID Connect per AAD o AAD B2C.
properties.clientId	string	ID client dell'applicazione nel provider di identità esterno. È ID app per Facebook account di accesso, ID client per Google login, ID app per Microsoft.
properties.clientLibrary	string	Libreria client da usare nel portale per sviluppatori. Si applica solo a AAD e AAD B2C Identity Provider.
properties.clientSecret	string	Segreto client dell'applicazione nel provider di identità esterno, usato per autenticare la richiesta di accesso. Ad esempio, è Segreto app per Facebook account di accesso, chiave API per l'account di accesso Google, chiave pubblica per Microsoft.
properties.passwordResetPolicyName	string	Nome criteri di reimpostazione della password. Si applica solo a AAD B2C Identity Provider.
properties.profileEditingPolicyName	string	Nome criteri di modifica del profilo. Si applica solo a AAD B2C Identity Provider.
properties.signinPolicyName	string	Nome criteri di accesso. Si applica solo a AAD B2C Identity Provider.
properties.signinTenant	string	TenantId da usare invece di Common quando si accede ad Active Directory
properties.signupPolicyName	string	Nome criteri di iscrizione. Si applica solo a AAD B2C Identity Provider.
properties.type	IdentityProviderType	Identificatore del tipo di provider di identità.

Risposte

Nome	Tipo	Descrizione
200 OK	IdentityProviderContract	Il provider di identità esistente è stato aggiornato correttamente. Headers ETag: string
Other Status Codes	ErrorResponse	Risposta di errore che descrive perché l'operazione non è riuscita.

Nome

Tipo

Descrizione

200 OK

IdentityProviderContract

Il provider di identità esistente è stato aggiornato correttamente.

Headers

ETag: string

Other Status Codes

ErrorResponse

Risposta di errore che descrive perché l'operazione non è riuscita.

Sicurezza

azure_auth

Flusso OAuth2 di Azure Active Directory.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Nome	Descrizione
user_impersonation	rappresentare l'account utente

Esempio

ApiManagementUpdateIdentityProvider

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/facebook?api-version=2022-08-01


{
  "properties": {
    "clientId": "updatedfacebookid",
    "clientSecret": "updatedfacebooksecret"
  }
}

import com.azure.resourcemanager.apimanagement.models.IdentityProviderContract;
import com.azure.resourcemanager.apimanagement.models.IdentityProviderType;

/** Samples for IdentityProvider Update. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateIdentityProvider.json
     */
    /**
     * Sample code: ApiManagementUpdateIdentityProvider.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementUpdateIdentityProvider(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        IdentityProviderContract resource =
            manager
                .identityProviders()
                .getWithResponse("rg1", "apimService1", IdentityProviderType.FACEBOOK, com.azure.core.util.Context.NONE)
                .getValue();
        resource
            .update()
            .withClientId("updatedfacebookid")
            .withClientSecret("updatedfacebooksecret")
            .withIfMatch("*")
            .apply();
    }
}

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

from typing import Any, IO, TYPE_CHECKING, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.apimanagement import ApiManagementClient

if TYPE_CHECKING:
    # pylint: disable=unused-import,ungrouped-imports
    from .. import models as _models
"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-apimanagement
# USAGE
    python api_management_update_identity_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="subid",
    )

    response = client.identity_provider.update(
        resource_group_name="rg1",
        service_name="apimService1",
        identity_provider_name="facebook",
        if_match="*",
        parameters={"properties": {"clientId": "updatedfacebookid", "clientSecret": "updatedfacebooksecret"}},
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateIdentityProvider.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

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/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4cd95123fb961c68740565a1efcaa5e43bd35802/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateIdentityProvider.json
func ExampleIdentityProviderClient_Update() {
	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.NewIdentityProviderClient().Update(ctx, "rg1", "apimService1", armapimanagement.IdentityProviderTypeFacebook, "*", armapimanagement.IdentityProviderUpdateParameters{
		Properties: &armapimanagement.IdentityProviderUpdateProperties{
			ClientID:     to.Ptr("updatedfacebookid"),
			ClientSecret: to.Ptr("updatedfacebooksecret"),
		},
	}, 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.IdentityProviderContract = armapimanagement.IdentityProviderContract{
	// 	Name: to.Ptr("AadB2C"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/identityProviders"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/AadB2C"),
	// 	Properties: &armapimanagement.IdentityProviderContractProperties{
	// 		Type: to.Ptr(armapimanagement.IdentityProviderTypeAADB2C),
	// 		AllowedTenants: []*string{
	// 			to.Ptr("contosoaadb2c.onmicrosoft.com"),
	// 			to.Ptr("contoso2aadb2c.onmicrosoft.com")},
	// 			Authority: to.Ptr("login.microsoftonline.com"),
	// 			SigninPolicyName: to.Ptr("B2C_1_policy-signin"),
	// 			SigninTenant: to.Ptr("contosoaadb2c.onmicrosoft.com"),
	// 			SignupPolicyName: to.Ptr("B2C_1_policy-signup"),
	// 			ClientID: to.Ptr("f02dafe2-b8b8-48ec-a38e-27e5c16c51e5"),
	// 		},
	// 	}
}

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

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

/**
 * This sample demonstrates how to Updates an existing IdentityProvider configuration.
 *
 * @summary Updates an existing IdentityProvider configuration.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2022-08-01/examples/ApiManagementUpdateIdentityProvider.json
 */
async function apiManagementUpdateIdentityProvider() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const identityProviderName = "facebook";
  const ifMatch = "*";
  const parameters = {
    clientId: "updatedfacebookid",
    clientSecret: "updatedfacebooksecret",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.identityProvider.update(
    resourceGroupName,
    serviceName,
    identityProviderName,
    ifMatch,
    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

Sample Response

Status code:: 200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/AadB2C",
  "type": "Microsoft.ApiManagement/service/identityProviders",
  "name": "AadB2C",
  "properties": {
    "clientId": "f02dafe2-b8b8-48ec-a38e-27e5c16c51e5",
    "type": "aadB2C",
    "authority": "login.microsoftonline.com",
    "signinTenant": "contosoaadb2c.onmicrosoft.com",
    "allowedTenants": [
      "contosoaadb2c.onmicrosoft.com",
      "contoso2aadb2c.onmicrosoft.com"
    ],
    "signupPolicyName": "B2C_1_policy-signup",
    "signinPolicyName": "B2C_1_policy-signin"
  }
}

Definizioni

Nome	Descrizione
ErrorFieldContract	Contratto campo errore.
ErrorResponse	Risposta errore.
IdentityProviderContract	Dettagli del provider di identità.
IdentityProviderType	Identificatore del tipo di provider di identità.
IdentityProviderUpdateParameters	Parametri forniti per aggiornare il provider di identità

ErrorFieldContract

Contratto campo errore.

Nome	Tipo	Descrizione
code	string	Codice di errore a livello di proprietà.
message	string	Rappresentazione leggibile dell'errore a livello di proprietà.
target	string	Nome della proprietà.

ErrorResponse

Risposta errore.

Nome	Tipo	Descrizione
error.code	string	Codice di errore definito dal servizio. Questo codice svolge la funzione di stato secondario per il codice di errore HTTP specificato nella risposta.
error.details	ErrorFieldContract[]	Elenco di campi non validi inviati nella richiesta, in caso di errore di convalida.
error.message	string	Rappresentazione leggibile dell'errore.

IdentityProviderContract

Dettagli del provider di identità.

Nome	Tipo	Descrizione
id	string	ID di risorsa completo per la risorsa. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	nome della risorsa.
properties.allowedTenants	string[]	Elenco dei tenant consentiti durante la configurazione dell'account di accesso di Azure Active Directory.
properties.authority	string	Nome host dell'endpoint di individuazione OpenID Connect per AAD o AAD B2C.
properties.clientId	string	ID client dell'applicazione nel provider di identità esterno. È ID app per Facebook account di accesso, ID client per Google login, ID app per Microsoft.
properties.clientLibrary	string	Libreria client da usare nel portale per sviluppatori. Si applica solo a AAD e AAD B2C Identity Provider.
properties.clientSecret	string	Segreto client dell'applicazione nel provider di identità esterno, usato per autenticare la richiesta di accesso. Ad esempio, è Segreto app per Facebook account di accesso, chiave API per l'account di accesso Google, chiave pubblica per Microsoft. Questa proprietà non verrà compilata nelle operazioni 'GET'. Usare la richiesta POST '/listSecrets' per ottenere il valore.
properties.passwordResetPolicyName	string	Nome criteri di reimpostazione della password. Si applica solo a AAD B2C Identity Provider.
properties.profileEditingPolicyName	string	Nome criteri di modifica del profilo. Si applica solo a AAD B2C Identity Provider.
properties.signinPolicyName	string	Nome criteri di accesso. Si applica solo a AAD B2C Identity Provider.
properties.signinTenant	string	TenantId da usare invece di Common quando si accede ad Active Directory
properties.signupPolicyName	string	Nome criteri di iscrizione. Si applica solo a AAD B2C Identity Provider.
properties.type	IdentityProviderType	Identificatore del tipo di provider di identità.
type	string	Tipo di risorsa. Ad esempio, "Microsoft.Compute/virtualMachines" o "Microsoft.Storage/storageAccounts"

IdentityProviderType

Identificatore del tipo di provider di identità.

Nome	Tipo	Descrizione
aad	string	Azure Active Directory come provider di identità.
aadB2C	string	Azure Active Directory B2C come provider di identità.
facebook	string	Facebook come provider di identità.
google	string	Google come provider di identità.
microsoft	string	Microsoft Live come provider di identità.
twitter	string	Twitter come provider di identità.