Identity Provider - Update

Serviço:

API Management

Versão da API:

2021-08-01

Atualizações uma configuração do IdentityProvider existente.

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

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
identityProviderName	path	True	IdentityProviderType	Identificador do Tipo de Fornecedor de Identidade.
resourceGroupName	path	True	string	O nome do grupo de recursos.
serviceName	path	True	string	O nome do serviço Gestão de API. Padrão Regex: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId	path	True	string	Credenciais de subscrição que identificam exclusivamente a subscrição do Microsoft Azure. O ID da subscrição faz parte do URI para cada chamada de serviço.
api-version	query	True	string	Versão da API a utilizar com o pedido de cliente.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
If-Match	True	string	ETag da Entidade. O ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho do pedido GET ou deve ser * para atualização incondicional.

Corpo do Pedido

Name	Tipo	Description
properties.allowedTenants	string[]	Lista de Inquilinos Permitidos ao configurar o início de sessão do Azure Active Directory.
properties.authority	string	Nome do anfitrião do ponto final de deteção do OpenID Connect para o AAD ou o AAD B2C.
properties.clientId	string	ID de cliente da Aplicação no Fornecedor de Identidade externo. É o ID da Aplicação para Facebook início de sessão, ID de Cliente para início de sessão do Google, ID da Aplicação para a Microsoft.
properties.clientSecret	string	Segredo do cliente da Aplicação no Fornecedor de Identidade externo, utilizado para autenticar o pedido de início de sessão. Por exemplo, é Segredo da Aplicação para Facebook início de sessão, Chave de API para início de sessão do Google, Chave Pública para a Microsoft.
properties.passwordResetPolicyName	string	Nome da Política de Reposição de Palavra-passe. Aplica-se apenas ao Fornecedor de Identidade do AAD B2C.
properties.profileEditingPolicyName	string	Nome da Política de Edição de Perfis. Aplica-se apenas ao Fornecedor de Identidade do AAD B2C.
properties.signinPolicyName	string	Nome da Política de Início de Sessão. Aplica-se apenas ao Fornecedor de Identidade do AAD B2C.
properties.signinTenant	string	O TenantId a utilizar em vez de Comum ao iniciar sessão no Active Directory
properties.signupPolicyName	string	Nome da Política de Inscrição. Aplica-se apenas ao Fornecedor de Identidade do AAD B2C.
properties.type	IdentityProviderType	Identificador do Tipo de Fornecedor de Identidade.

Respostas

Name	Tipo	Description
200 OK	IdentityProviderContract	O Fornecedor de Identidade existente foi atualizado com êxito. Cabeçalhos ETag: string
Other Status Codes	ErrorResponse	Resposta de erro que descreve a razão pela qual a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name	Description
user_impersonation	representar a sua conta de utilizador

Exemplos

ApiManagementUpdateIdentityProvider

Pedido de amostra

HTTP

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


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

Java

import com.azure.core.util.Context;
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/2021-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, 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

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_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/2021-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

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/c767823fdfd9d5e96bad245e3ea4d14d94a716bb/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-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

JavaScript

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/2021-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

dotnet

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

// Generated from example definition: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementUpdateIdentityProvider.json
// this example is just showing the usage of "IdentityProvider_Update" 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 ApiManagementIdentityProviderResource created on azure
// for more information of creating ApiManagementIdentityProviderResource, please refer to the document of ApiManagementIdentityProviderResource
string subscriptionId = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
IdentityProviderType identityProviderName = IdentityProviderType.Facebook;
ResourceIdentifier apiManagementIdentityProviderResourceId = ApiManagementIdentityProviderResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName, identityProviderName);
ApiManagementIdentityProviderResource apiManagementIdentityProvider = client.GetApiManagementIdentityProviderResource(apiManagementIdentityProviderResourceId);

// invoke the operation
ETag ifMatch = new ETag("*");
ApiManagementIdentityProviderPatch patch = new ApiManagementIdentityProviderPatch()
{
    ClientId = "updatedfacebookid",
    ClientSecret = "updatedfacebooksecret",
};
ApiManagementIdentityProviderResource result = await apiManagementIdentityProvider.UpdateAsync(ifMatch, patch);

// 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
ApiManagementIdentityProviderData 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

Resposta da amostra

Código de estado:

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"
  }
}

Definições

Name	Description
ErrorFieldContract	Contrato de campo de erro.
ErrorResponse	Resposta a Erros.
IdentityProviderContract	Detalhes do Fornecedor de Identidade.
IdentityProviderType	Identificador do Tipo de Fornecedor de Identidade.
IdentityProviderUpdateParameters	Parâmetros fornecidos para atualizar o Fornecedor de Identidade

ErrorFieldContract

Contrato de campo de erro.

Name	Tipo	Description
code	string	Código de erro ao nível da propriedade.
message	string	Representação legível por humanos do erro ao nível da propriedade.
target	string	Nome da propriedade.

ErrorResponse

Resposta a Erros.

Name	Tipo	Description
error.code	string	Código de erro definido pelo serviço. Este código serve como um sub-estado para o código de erro HTTP especificado na resposta.
error.details	ErrorFieldContract[]	A lista de campos inválidos enviados a pedido, em caso de erro de validação.
error.message	string	Representação legível por humanos do erro.

IdentityProviderContract

Detalhes do Fornecedor de Identidade.

Name	Tipo	Description
id	string	ID de recurso completamente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.allowedTenants	string[]	Lista de Inquilinos Permitidos ao configurar o início de sessão do Azure Active Directory.
properties.authority	string	Nome do anfitrião do ponto final de deteção do OpenID Connect para o AAD ou o AAD B2C.
properties.clientId	string	ID de cliente da Aplicação no Fornecedor de Identidade externo. É o ID da Aplicação para Facebook início de sessão, ID de Cliente para início de sessão do Google, ID da Aplicação para a Microsoft.
properties.clientSecret	string	Segredo do cliente da Aplicação no Fornecedor de Identidade externo, utilizado para autenticar o pedido de início de sessão. Por exemplo, é Segredo da Aplicação para Facebook início de sessão, Chave de API para início de sessão do Google, Chave Pública para a Microsoft. Esta propriedade não será preenchida em operações "GET"! Utilize o pedido POST "/listSecrets" para obter o valor.
properties.passwordResetPolicyName	string	Nome da Política de Reposição de Palavra-passe. Aplica-se apenas ao Fornecedor de Identidade do AAD B2C.
properties.profileEditingPolicyName	string	Nome da Política de Edição de Perfis. Aplica-se apenas ao Fornecedor de Identidade do AAD B2C.
properties.signinPolicyName	string	Nome da Política de Início de Sessão. Aplica-se apenas ao Fornecedor de Identidade do AAD B2C.
properties.signinTenant	string	O TenantId a utilizar em vez de Comum ao iniciar sessão no Active Directory
properties.signupPolicyName	string	Nome da Política de Inscrição. Aplica-se apenas ao Fornecedor de Identidade do AAD B2C.
properties.type	IdentityProviderType	Identificador do Tipo de Fornecedor de Identidade.
type	string	O tipo de recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

IdentityProviderType

Identificador do Tipo de Fornecedor de Identidade.

Name	Tipo	Description
aad	string	Azure Active Directory como Fornecedor de identidade.
aadB2C	string	Azure Active Directory B2C como Fornecedor de identidade.
facebook	string	Facebook como fornecedor de Identidade.
google	string	Google como fornecedor de Identidade.
microsoft	string	Fornecedor do Microsoft Live como Identidade.
twitter	string	Twitter como fornecedor de identidade.

IdentityProviderUpdateParameters

Parâmetros fornecidos para atualizar o Fornecedor de Identidade

Name	Tipo	Description
properties.allowedTenants	string[]	Lista de Inquilinos Permitidos ao configurar o início de sessão do Azure Active Directory.
properties.authority	string	Nome do anfitrião do ponto final de deteção do OpenID Connect para o AAD ou o AAD B2C.
properties.clientId	string	ID de cliente da Aplicação no Fornecedor de Identidade externo. É o ID da Aplicação para Facebook início de sessão, ID de Cliente para início de sessão do Google, ID da Aplicação para a Microsoft.
properties.clientSecret	string	Segredo do cliente da Aplicação no Fornecedor de Identidade externo, utilizado para autenticar o pedido de início de sessão. Por exemplo, é Segredo da Aplicação para Facebook início de sessão, Chave de API para início de sessão do Google, Chave Pública para a Microsoft.
properties.passwordResetPolicyName	string	Nome da Política de Reposição de Palavra-passe. Aplica-se apenas ao Fornecedor de Identidade do AAD B2C.
properties.profileEditingPolicyName	string	Nome da Política de Edição de Perfis. Aplica-se apenas ao Fornecedor de Identidade do AAD B2C.
properties.signinPolicyName	string	Nome da Política de Início de Sessão. Aplica-se apenas ao Fornecedor de Identidade do AAD B2C.
properties.signinTenant	string	O TenantId a utilizar em vez de Comum ao iniciar sessão no Active Directory
properties.signupPolicyName	string	Nome da Política de Inscrição. Aplica-se apenas ao Fornecedor de Identidade do AAD B2C.
properties.type	IdentityProviderType	Identificador do Tipo de Fornecedor de Identidade.