Identity Provider - Create Or Update

Serviço:

API Management

Versão da API:

2021-08-01

Cria ou atualiza a configuração do IdentityProvider.

PUT 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 provedor de identidade.
resourceGroupName	path	True	string	O nome do grupo de recursos.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	O nome do serviço de Gerenciamento de API.
subscriptionId	path	True	string	Credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. O ID da assinatura faz parte do URI de cada chamada de serviço.
api-version	query	True	string	Versão da API a ser usada com a solicitação do cliente.

Cabeçalho do Pedido

Name	Necessário	Tipo	Description
If-Match		string	ETag da Entidade. Não é necessário ao criar uma entidade, mas é necessário ao atualizar uma entidade.

Corpo do Pedido

Name	Necessário	Tipo	Description
properties.clientId	True	string minLength: 1	ID do cliente do aplicativo no provedor de identidade externo. É o ID do aplicativo para o login do Facebook, o ID do cliente para o login do Google, o ID do aplicativo para a Microsoft.
properties.clientSecret	True	string minLength: 1	Segredo do cliente do Aplicativo no Provedor de Identidade externo, usado para autenticar a solicitação de login. Por exemplo, é App Secret para login do Facebook, API Key para login do Google, Chave Pública para Microsoft. Esta propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor.
properties.allowedTenants		string[]	Lista de Locatários Permitidos ao configurar o logon do Azure Ative Directory.
properties.authority		string	Nome do host do ponto de extremidade de descoberta do OpenID Connect para AAD ou AAD B2C.
properties.passwordResetPolicyName		string minLength: 1	Nome da política de redefinição de senha. Aplica-se apenas ao AAD B2C Identity Provider.
properties.profileEditingPolicyName		string minLength: 1	Nome da política de edição de perfil. Aplica-se apenas ao AAD B2C Identity Provider.
properties.signinPolicyName		string minLength: 1	Nome da política de login. Aplica-se apenas ao AAD B2C Identity Provider.
properties.signinTenant		string	O TenantId a ser usado em vez de Comum ao fazer login no Ative Directory
properties.signupPolicyName		string minLength: 1	Nome da política de inscrição. Aplica-se apenas ao AAD B2C Identity Provider.
properties.type		IdentityProviderType	Identificador do tipo de provedor de identidade.

Respostas

Name	Tipo	Description
200 OK	IdentityProviderContract	O provedor de identidade existente foi atualizado com êxito. Cabeçalhos ETag: string
201 Created	IdentityProviderContract	A configuração do IdentityProvider foi criada com êxito. Cabeçalhos ETag: string
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

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

Âmbitos

Name	Description
user_impersonation	personificar a sua conta de utilizador

Exemplos

ApiManagementCreateIdentityProvider

Pedido de amostra

HTTP

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

{
  "properties": {
    "clientId": "facebookid",
    "clientSecret": "facebookapplicationsecret"
  }
}

Java

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

/** Samples for IdentityProvider CreateOrUpdate. */
public final class Main {
    /*
     * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementCreateIdentityProvider.json
     */
    /**
     * Sample code: ApiManagementCreateIdentityProvider.
     *
     * @param manager Entry point to ApiManagementManager.
     */
    public static void apiManagementCreateIdentityProvider(
        com.azure.resourcemanager.apimanagement.ApiManagementManager manager) {
        manager
            .identityProviders()
            .define(IdentityProviderType.FACEBOOK)
            .withExistingService("rg1", "apimService1")
            .withClientId("facebookid")
            .withClientSecret("facebookapplicationsecret")
            .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_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.create_or_update(
        resource_group_name="rg1",
        service_name="apimService1",
        identity_provider_name="facebook",
        parameters={"properties": {"clientId": "facebookid", "clientSecret": "facebookapplicationsecret"}},
    )
    print(response)


# x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementCreateIdentityProvider.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/ApiManagementCreateIdentityProvider.json
func ExampleIdentityProviderClient_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.NewIdentityProviderClient().CreateOrUpdate(ctx, "rg1", "apimService1", armapimanagement.IdentityProviderTypeFacebook, armapimanagement.IdentityProviderCreateContract{
		Properties: &armapimanagement.IdentityProviderCreateContractProperties{
			ClientID:     to.Ptr("facebookid"),
			ClientSecret: to.Ptr("facebookapplicationsecret"),
		},
	}, &armapimanagement.IdentityProviderClientCreateOrUpdateOptions{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.IdentityProviderContract = armapimanagement.IdentityProviderContract{
	// 	Name: to.Ptr("Facebook"),
	// 	Type: to.Ptr("Microsoft.ApiManagement/service/identityProviders"),
	// 	ID: to.Ptr("/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Facebook"),
	// 	Properties: &armapimanagement.IdentityProviderContractProperties{
	// 		Type: to.Ptr(armapimanagement.IdentityProviderTypeFacebook),
	// 		ClientID: to.Ptr("facebookid"),
	// 	},
	// }
}

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 Creates or Updates the IdentityProvider configuration.
 *
 * @summary Creates or Updates the IdentityProvider configuration.
 * x-ms-original-file: specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2021-08-01/examples/ApiManagementCreateIdentityProvider.json
 */
async function apiManagementCreateIdentityProvider() {
  const subscriptionId = process.env["APIMANAGEMENT_SUBSCRIPTION_ID"] || "subid";
  const resourceGroupName = process.env["APIMANAGEMENT_RESOURCE_GROUP"] || "rg1";
  const serviceName = "apimService1";
  const identityProviderName = "facebook";
  const parameters = {
    clientId: "facebookid",
    clientSecret: "facebookapplicationsecret",
  };
  const credential = new DefaultAzureCredential();
  const client = new ApiManagementClient(credential, subscriptionId);
  const result = await client.identityProvider.createOrUpdate(
    resourceGroupName,
    serviceName,
    identityProviderName,
    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/ApiManagementCreateIdentityProvider.json
// this example is just showing the usage of "IdentityProvider_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 = "subid";
string resourceGroupName = "rg1";
string serviceName = "apimService1";
ResourceIdentifier apiManagementServiceResourceId = ApiManagementServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, serviceName);
ApiManagementServiceResource apiManagementService = client.GetApiManagementServiceResource(apiManagementServiceResourceId);

// get the collection of this ApiManagementIdentityProviderResource
ApiManagementIdentityProviderCollection collection = apiManagementService.GetApiManagementIdentityProviders();

// invoke the operation
IdentityProviderType identityProviderName = IdentityProviderType.Facebook;
ApiManagementIdentityProviderCreateOrUpdateContent content = new ApiManagementIdentityProviderCreateOrUpdateContent()
{
    ClientId = "facebookid",
    ClientSecret = "facebookapplicationsecret",
};
ArmOperation<ApiManagementIdentityProviderResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, identityProviderName, content);
ApiManagementIdentityProviderResource 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
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:

201

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Facebook",
  "type": "Microsoft.ApiManagement/service/identityProviders",
  "name": "Facebook",
  "properties": {
    "clientId": "facebookid",
    "type": "facebook"
  }
}

Código de estado:

200

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/identityProviders/Facebook",
  "type": "Microsoft.ApiManagement/service/identityProviders",
  "name": "Facebook",
  "properties": {
    "clientId": "facebookid",
    "type": "facebook"
  }
}

Definições

Name	Description
ErrorFieldContract	Contrato de campo de erro.
ErrorResponse	Resposta de erro.
IdentityProviderContract	Detalhes do provedor de identidade.
IdentityProviderCreateContract	Detalhes do provedor de identidade.
IdentityProviderType	Identificador do tipo de provedor de identidade.

ErrorFieldContract

Object

Contrato de campo de erro.

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

ErrorResponse

Object

Resposta de erro.

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

IdentityProviderContract

Object

Detalhes do provedor de identidade.

Name	Tipo	Description
id	string	ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.allowedTenants	string[]	Lista de Locatários Permitidos ao configurar o logon do Azure Ative Directory.
properties.authority	string	Nome do host do ponto de extremidade de descoberta do OpenID Connect para AAD ou AAD B2C.
properties.clientId	string minLength: 1	ID do cliente do aplicativo no provedor de identidade externo. É o ID do aplicativo para o login do Facebook, o ID do cliente para o login do Google, o ID do aplicativo para a Microsoft.
properties.clientSecret	string minLength: 1	Segredo do cliente do Aplicativo no Provedor de Identidade externo, usado para autenticar a solicitação de login. Por exemplo, é App Secret para login do Facebook, API Key para login do Google, Chave Pública para Microsoft. Esta propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor.
properties.passwordResetPolicyName	string minLength: 1	Nome da política de redefinição de senha. Aplica-se apenas ao AAD B2C Identity Provider.
properties.profileEditingPolicyName	string minLength: 1	Nome da política de edição de perfil. Aplica-se apenas ao AAD B2C Identity Provider.
properties.signinPolicyName	string minLength: 1	Nome da política de login. Aplica-se apenas ao AAD B2C Identity Provider.
properties.signinTenant	string	O TenantId a ser usado em vez de Comum ao fazer login no Ative Directory
properties.signupPolicyName	string minLength: 1	Nome da política de inscrição. Aplica-se apenas ao AAD B2C Identity Provider.
properties.type	IdentityProviderType	Identificador do tipo de provedor de identidade.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

IdentityProviderCreateContract

Object

Detalhes do provedor de identidade.

Name	Tipo	Description
id	string	ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.allowedTenants	string[]	Lista de Locatários Permitidos ao configurar o logon do Azure Ative Directory.
properties.authority	string	Nome do host do ponto de extremidade de descoberta do OpenID Connect para AAD ou AAD B2C.
properties.clientId	string minLength: 1	ID do cliente do aplicativo no provedor de identidade externo. É o ID do aplicativo para o login do Facebook, o ID do cliente para o login do Google, o ID do aplicativo para a Microsoft.
properties.clientSecret	string minLength: 1	Segredo do cliente do Aplicativo no Provedor de Identidade externo, usado para autenticar a solicitação de login. Por exemplo, é App Secret para login do Facebook, API Key para login do Google, Chave Pública para Microsoft. Esta propriedade não será preenchida em operações 'GET'! Use a solicitação POST '/listSecrets' para obter o valor.
properties.passwordResetPolicyName	string minLength: 1	Nome da política de redefinição de senha. Aplica-se apenas ao AAD B2C Identity Provider.
properties.profileEditingPolicyName	string minLength: 1	Nome da política de edição de perfil. Aplica-se apenas ao AAD B2C Identity Provider.
properties.signinPolicyName	string minLength: 1	Nome da política de login. Aplica-se apenas ao AAD B2C Identity Provider.
properties.signinTenant	string	O TenantId a ser usado em vez de Comum ao fazer login no Ative Directory
properties.signupPolicyName	string minLength: 1	Nome da política de inscrição. Aplica-se apenas ao AAD B2C Identity Provider.
properties.type	IdentityProviderType	Identificador do tipo de provedor de identidade.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

IdentityProviderType

Enumeração

Identificador do tipo de provedor de identidade.

Valor	Description
aad	Azure Ative Directory como provedor de identidade.
aadB2C	Azure Ative Directory B2C como provedor de identidade.
facebook	Facebook como provedor de identidade.
google	Google como fornecedor de identidade.
microsoft	Microsoft Live como provedor de identidade.
twitter	Twitter como provedor de identidade.