Delen via

Microsoft.ApiManagement-service/identityProviders 2024-06-01-preview

  • Artikel

Bicep-resourcedefinitie

Het resourcetype service/identityProviders kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Resource microsoft.ApiManagement/service/identityProviders wilt maken, voegt u de volgende Bicep toe aan uw sjabloon.

resource symbolicname 'Microsoft.ApiManagement/service/identityProviders@2024-06-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    allowedTenants: [
      'string'
    ]
    authority: 'string'
    certificateId: 'string'
    clientId: 'string'
    clientLibrary: 'string'
    clientSecret: 'string'
    passwordResetPolicyName: 'string'
    profileEditingPolicyName: 'string'
    signinPolicyName: 'string'
    signinTenant: 'string'
    signupPolicyName: 'string'
    type: 'string'
  }
}

Eigenschapswaarden

IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties

Naam Beschrijving Waarde
allowedTenants Lijst met toegestane tenants bij het configureren van Azure Active Directory-aanmelding. tekenreeks[]
autoriteit OpenID Connect-detectie-eindpunthostnaam voor AAD of AAD B2C. snaar
certificateId Volledige certificaatresource-id die wordt gebruikt in externe id-provider snaar
clientId Client-id van de toepassing in de externe id-provider. Het is app-id voor Facebook-aanmelding, client-id voor Google-aanmelding, app-id voor Microsoft. snaar

Beperkingen:
Minimale lengte = 1 (vereist)
clientLibrary De clientbibliotheek die moet worden gebruikt in de ontwikkelaarsportal. Alleen van toepassing op AAD en AAD B2C Identity Provider. snaar

Beperkingen:
Maximale lengte =
clientSecret Clientgeheim van de toepassing in externe id-provider, die wordt gebruikt om aanmeldingsaanvraag te verifiëren. Het is bijvoorbeeld app-geheim voor Facebook-aanmelding, API-sleutel voor Google-aanmelding, openbare sleutel voor Microsoft. Deze eigenschap wordt niet ingevuld voor 'GET'-bewerkingen. Gebruik POST-aanvraag '/listSecrets' om de waarde op te halen. snaar

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter. (vereist)
passwordResetPolicyName De beleidsnaam voor het opnieuw instellen van het wachtwoord. Alleen van toepassing op AAD B2C Identity Provider. snaar

Beperkingen:
Minimale lengte = 1
profileEditingPolicyName Naam van profielbewerkingsbeleid. Alleen van toepassing op AAD B2C Identity Provider. snaar

Beperkingen:
Minimale lengte = 1
signinPolicyName Naam van aanmeldingsbeleid. Alleen van toepassing op AAD B2C Identity Provider. snaar

Beperkingen:
Minimale lengte = 1
signinTenant De TenantId die moet worden gebruikt in plaats van Common wanneer u zich aanmeldt bij Active Directory snaar
signupPolicyName Naam van registratiebeleid. Alleen van toepassing op AAD B2C Identity Provider. snaar

Beperkingen:
Minimale lengte = 1
type Id van id-providertype. 'aad'
'aadB2C'
'facebook'
'google'
'microsoft'
'twitter'

Microsoft.ApiManagement/service/identityProviders

Naam Beschrijving Waarde
naam De resourcenaam 'aad'
'aadB2C'
'facebook'
'google'
'microsoft'
'twitter' (vereist)
ouder In Bicep kunt u de bovenliggende resource voor een onderliggende resource opgeven. U hoeft deze eigenschap alleen toe te voegen wanneer de onderliggende resource buiten de bovenliggende resource wordt gedeclareerd.

Zie onderliggende resource buiten de bovenliggende resourcevoor meer informatie.		 Symbolische naam voor resource van het type: service
Eigenschappen Eigenschappen van id-providercontract. IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties

Resourcedefinitie van ARM-sjabloon

Het resourcetype service/identityProviders kan worden geïmplementeerd met bewerkingen die zijn gericht op:

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.ApiManagement/service/identityProviders-resource wilt maken, voegt u de volgende JSON toe aan uw sjabloon.

{
  "type": "Microsoft.ApiManagement/service/identityProviders",
  "apiVersion": "2024-06-01-preview",
  "name": "string",
  "properties": {
    "allowedTenants": [ "string" ],
    "authority": "string",
    "certificateId": "string",
    "clientId": "string",
    "clientLibrary": "string",
    "clientSecret": "string",
    "passwordResetPolicyName": "string",
    "profileEditingPolicyName": "string",
    "signinPolicyName": "string",
    "signinTenant": "string",
    "signupPolicyName": "string",
    "type": "string"
  }
}

Eigenschapswaarden

IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties

Naam Beschrijving Waarde
allowedTenants Lijst met toegestane tenants bij het configureren van Azure Active Directory-aanmelding. tekenreeks[]
autoriteit OpenID Connect-detectie-eindpunthostnaam voor AAD of AAD B2C. snaar
certificateId Volledige certificaatresource-id die wordt gebruikt in externe id-provider snaar
clientId Client-id van de toepassing in de externe id-provider. Het is app-id voor Facebook-aanmelding, client-id voor Google-aanmelding, app-id voor Microsoft. snaar

Beperkingen:
Minimale lengte = 1 (vereist)
clientLibrary De clientbibliotheek die moet worden gebruikt in de ontwikkelaarsportal. Alleen van toepassing op AAD en AAD B2C Identity Provider. snaar

Beperkingen:
Maximale lengte =
clientSecret Clientgeheim van de toepassing in externe id-provider, die wordt gebruikt om aanmeldingsaanvraag te verifiëren. Het is bijvoorbeeld app-geheim voor Facebook-aanmelding, API-sleutel voor Google-aanmelding, openbare sleutel voor Microsoft. Deze eigenschap wordt niet ingevuld voor 'GET'-bewerkingen. Gebruik POST-aanvraag '/listSecrets' om de waarde op te halen. snaar

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter. (vereist)
passwordResetPolicyName De beleidsnaam voor het opnieuw instellen van het wachtwoord. Alleen van toepassing op AAD B2C Identity Provider. snaar

Beperkingen:
Minimale lengte = 1
profileEditingPolicyName Naam van profielbewerkingsbeleid. Alleen van toepassing op AAD B2C Identity Provider. snaar

Beperkingen:
Minimale lengte = 1
signinPolicyName Naam van aanmeldingsbeleid. Alleen van toepassing op AAD B2C Identity Provider. snaar

Beperkingen:
Minimale lengte = 1
signinTenant De TenantId die moet worden gebruikt in plaats van Common wanneer u zich aanmeldt bij Active Directory snaar
signupPolicyName Naam van registratiebeleid. Alleen van toepassing op AAD B2C Identity Provider. snaar

Beperkingen:
Minimale lengte = 1
type Id van id-providertype. 'aad'
'aadB2C'
'facebook'
'google'
'microsoft'
'twitter'

Microsoft.ApiManagement/service/identityProviders

Naam Beschrijving Waarde
apiVersion De API-versie '2024-06-01-preview'
naam De resourcenaam 'aad'
'aadB2C'
'facebook'
'google'
'microsoft'
'twitter' (vereist)
Eigenschappen Eigenschappen van id-providercontract. IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties
type Het resourcetype 'Microsoft.ApiManagement/service/identityProviders'

Resourcedefinitie van Terraform (AzAPI-provider)

Het resourcetype service/identityProviders kan worden geïmplementeerd met bewerkingen die zijn gericht op:

  • resourcegroepen

Zie logboek wijzigenvoor een lijst met gewijzigde eigenschappen in elke API-versie.

Resource-indeling

Als u een Microsoft.ApiManagement/service/identityProviders-resource wilt maken, voegt u de volgende Terraform toe aan uw sjabloon.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/identityProviders@2024-06-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      allowedTenants = [
        "string"
      ]
      authority = "string"
      certificateId = "string"
      clientId = "string"
      clientLibrary = "string"
      clientSecret = "string"
      passwordResetPolicyName = "string"
      profileEditingPolicyName = "string"
      signinPolicyName = "string"
      signinTenant = "string"
      signupPolicyName = "string"
      type = "string"
    }
  })
}

Eigenschapswaarden

IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties

Naam Beschrijving Waarde
allowedTenants Lijst met toegestane tenants bij het configureren van Azure Active Directory-aanmelding. tekenreeks[]
autoriteit OpenID Connect-detectie-eindpunthostnaam voor AAD of AAD B2C. snaar
certificateId Volledige certificaatresource-id die wordt gebruikt in externe id-provider snaar
clientId Client-id van de toepassing in de externe id-provider. Het is app-id voor Facebook-aanmelding, client-id voor Google-aanmelding, app-id voor Microsoft. snaar

Beperkingen:
Minimale lengte = 1 (vereist)
clientLibrary De clientbibliotheek die moet worden gebruikt in de ontwikkelaarsportal. Alleen van toepassing op AAD en AAD B2C Identity Provider. snaar

Beperkingen:
Maximale lengte =
clientSecret Clientgeheim van de toepassing in externe id-provider, die wordt gebruikt om aanmeldingsaanvraag te verifiëren. Het is bijvoorbeeld app-geheim voor Facebook-aanmelding, API-sleutel voor Google-aanmelding, openbare sleutel voor Microsoft. Deze eigenschap wordt niet ingevuld voor 'GET'-bewerkingen. Gebruik POST-aanvraag '/listSecrets' om de waarde op te halen. snaar

Beperkingen:
Minimale lengte = 1
Gevoelige waarde. Doorgeven als een beveiligde parameter. (vereist)
passwordResetPolicyName De beleidsnaam voor het opnieuw instellen van het wachtwoord. Alleen van toepassing op AAD B2C Identity Provider. snaar

Beperkingen:
Minimale lengte = 1
profileEditingPolicyName Naam van profielbewerkingsbeleid. Alleen van toepassing op AAD B2C Identity Provider. snaar

Beperkingen:
Minimale lengte = 1
signinPolicyName Naam van aanmeldingsbeleid. Alleen van toepassing op AAD B2C Identity Provider. snaar

Beperkingen:
Minimale lengte = 1
signinTenant De TenantId die moet worden gebruikt in plaats van Common wanneer u zich aanmeldt bij Active Directory snaar
signupPolicyName Naam van registratiebeleid. Alleen van toepassing op AAD B2C Identity Provider. snaar

Beperkingen:
Minimale lengte = 1
type Id van id-providertype. 'aad'
'aadB2C'
'facebook'
'google'
'microsoft'
'twitter'

Microsoft.ApiManagement/service/identityProviders

Naam Beschrijving Waarde
naam De resourcenaam 'aad'
'aadB2C'
'facebook'
'google'
'microsoft'
'twitter' (vereist)
parent_id De id van de resource die het bovenliggende item voor deze resource is. Id voor resource van het type: service-
Eigenschappen Eigenschappen van id-providercontract. IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties
type Het resourcetype "Microsoft.ApiManagement/service/identityProviders@2024-06-01-preview"