Udostępnij za pośrednictwem

Microsoft.ApiManagement service/identityProviders 2021-01-01-preview

  • Artykuł

Definicja zasobu Bicep

Typ zasobu service/identityProviders można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/service/identityProviders, dodaj następujący kod Bicep do szablonu.

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

Wartości właściwości

IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties

Nazwa Opis Wartość
allowedTenants Lista dozwolonych dzierżaw podczas konfigurowania logowania do usługi Azure Active Directory. string[]
autorytet OpenID Connect nazwa hosta punktu końcowego odnajdywania dla usługi AAD lub usługi AAD B2C. struna
clientId Identyfikator klienta aplikacji w zewnętrznym dostawcy tożsamości. Jest to identyfikator aplikacji dla logowania do serwisu Facebook, identyfikator klienta logowania Google, identyfikator aplikacji dla firmy Microsoft. struna

Ograniczenia:
Minimalna długość = 1 (wymagana)
clientSecret Wpis tajny klienta aplikacji w zewnętrznym dostawcy tożsamości używany do uwierzytelniania żądania logowania. Na przykład jest to wpis tajny aplikacji na potrzeby logowania do serwisu Facebook, klucz interfejsu API do logowania Google, klucz publiczny dla firmy Microsoft. Ta właściwość nie zostanie wypełniona na operacjach "GET". Użyj żądania POST "/listSecrets", aby uzyskać wartość. struna

Ograniczenia:
Minimalna długość = 1
Wartość wrażliwa. Przekaż jako bezpieczny parametr. (wymagane)
passwordResetPolicyName Nazwa zasad resetowania hasła. Dotyczy tylko dostawcy tożsamości usługi AAD B2C. struna

Ograniczenia:
Minimalna długość = 1
profileEditingPolicyName Nazwa zasad edytowania profilu. Dotyczy tylko dostawcy tożsamości usługi AAD B2C. struna

Ograniczenia:
Minimalna długość = 1
signinPolicyName Nazwa zasad logowania. Dotyczy tylko dostawcy tożsamości usługi AAD B2C. struna

Ograniczenia:
Minimalna długość = 1
signinTenant Identyfikator TenantId do użycia zamiast typowego podczas logowania się do usługi Active Directory struna
signupPolicyName Nazwa zasad rejestracji. Dotyczy tylko dostawcy tożsamości usługi AAD B2C. struna

Ograniczenia:
Minimalna długość = 1
typ Identyfikator typu dostawcy tożsamości. "aad"
"aadB2C"
"facebook"
"google"
"microsoft"
"twitter"

Microsoft.ApiManagement/service/identityProviders

Nazwa Opis Wartość
nazwa Nazwa zasobu "aad"
"aadB2C"
"facebook"
"google"
"microsoft"
"twitter" (wymagane)
rodzic W Bicep można określić zasób nadrzędny dla zasobu podrzędnego. Tę właściwość należy dodać tylko wtedy, gdy zasób podrzędny jest zadeklarowany poza zasobem nadrzędnym.

Aby uzyskać więcej informacji, zobacz Zasób podrzędny poza zasobem nadrzędnym.		 Nazwa symboliczna zasobu typu: usługi
Właściwości Właściwości kontraktu dostawcy tożsamości. IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties

Definicja zasobu szablonu usługi ARM

Typ zasobu service/identityProviders można wdrożyć przy użyciu operacji docelowych:

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/service/identityProviders, dodaj następujący kod JSON do szablonu.

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

Wartości właściwości

IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties

Nazwa Opis Wartość
allowedTenants Lista dozwolonych dzierżaw podczas konfigurowania logowania do usługi Azure Active Directory. string[]
autorytet OpenID Connect nazwa hosta punktu końcowego odnajdywania dla usługi AAD lub usługi AAD B2C. struna
clientId Identyfikator klienta aplikacji w zewnętrznym dostawcy tożsamości. Jest to identyfikator aplikacji dla logowania do serwisu Facebook, identyfikator klienta logowania Google, identyfikator aplikacji dla firmy Microsoft. struna

Ograniczenia:
Minimalna długość = 1 (wymagana)
clientSecret Wpis tajny klienta aplikacji w zewnętrznym dostawcy tożsamości używany do uwierzytelniania żądania logowania. Na przykład jest to wpis tajny aplikacji na potrzeby logowania do serwisu Facebook, klucz interfejsu API do logowania Google, klucz publiczny dla firmy Microsoft. Ta właściwość nie zostanie wypełniona na operacjach "GET". Użyj żądania POST "/listSecrets", aby uzyskać wartość. struna

Ograniczenia:
Minimalna długość = 1
Wartość wrażliwa. Przekaż jako bezpieczny parametr. (wymagane)
passwordResetPolicyName Nazwa zasad resetowania hasła. Dotyczy tylko dostawcy tożsamości usługi AAD B2C. struna

Ograniczenia:
Minimalna długość = 1
profileEditingPolicyName Nazwa zasad edytowania profilu. Dotyczy tylko dostawcy tożsamości usługi AAD B2C. struna

Ograniczenia:
Minimalna długość = 1
signinPolicyName Nazwa zasad logowania. Dotyczy tylko dostawcy tożsamości usługi AAD B2C. struna

Ograniczenia:
Minimalna długość = 1
signinTenant Identyfikator TenantId do użycia zamiast typowego podczas logowania się do usługi Active Directory struna
signupPolicyName Nazwa zasad rejestracji. Dotyczy tylko dostawcy tożsamości usługi AAD B2C. struna

Ograniczenia:
Minimalna długość = 1
typ Identyfikator typu dostawcy tożsamości. "aad"
"aadB2C"
"facebook"
"google"
"microsoft"
"twitter"

Microsoft.ApiManagement/service/identityProviders

Nazwa Opis Wartość
apiVersion Wersja interfejsu API "2021-01-01-preview"
nazwa Nazwa zasobu "aad"
"aadB2C"
"facebook"
"google"
"microsoft"
"twitter" (wymagane)
Właściwości Właściwości kontraktu dostawcy tożsamości. IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties
typ Typ zasobu "Microsoft.ApiManagement/service/identityProviders"

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu service/identityProviders można wdrożyć przy użyciu operacji docelowych:

  • grupy zasobów

Aby uzyskać listę zmienionych właściwości w każdej wersji interfejsu API, zobacz dziennika zmian.

Format zasobu

Aby utworzyć zasób Microsoft.ApiManagement/service/identityProviders, dodaj następujący program Terraform do szablonu.

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

Wartości właściwości

IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties

Nazwa Opis Wartość
allowedTenants Lista dozwolonych dzierżaw podczas konfigurowania logowania do usługi Azure Active Directory. string[]
autorytet OpenID Connect nazwa hosta punktu końcowego odnajdywania dla usługi AAD lub usługi AAD B2C. struna
clientId Identyfikator klienta aplikacji w zewnętrznym dostawcy tożsamości. Jest to identyfikator aplikacji dla logowania do serwisu Facebook, identyfikator klienta logowania Google, identyfikator aplikacji dla firmy Microsoft. struna

Ograniczenia:
Minimalna długość = 1 (wymagana)
clientSecret Wpis tajny klienta aplikacji w zewnętrznym dostawcy tożsamości używany do uwierzytelniania żądania logowania. Na przykład jest to wpis tajny aplikacji na potrzeby logowania do serwisu Facebook, klucz interfejsu API do logowania Google, klucz publiczny dla firmy Microsoft. Ta właściwość nie zostanie wypełniona na operacjach "GET". Użyj żądania POST "/listSecrets", aby uzyskać wartość. struna

Ograniczenia:
Minimalna długość = 1
Wartość wrażliwa. Przekaż jako bezpieczny parametr. (wymagane)
passwordResetPolicyName Nazwa zasad resetowania hasła. Dotyczy tylko dostawcy tożsamości usługi AAD B2C. struna

Ograniczenia:
Minimalna długość = 1
profileEditingPolicyName Nazwa zasad edytowania profilu. Dotyczy tylko dostawcy tożsamości usługi AAD B2C. struna

Ograniczenia:
Minimalna długość = 1
signinPolicyName Nazwa zasad logowania. Dotyczy tylko dostawcy tożsamości usługi AAD B2C. struna

Ograniczenia:
Minimalna długość = 1
signinTenant Identyfikator TenantId do użycia zamiast typowego podczas logowania się do usługi Active Directory struna
signupPolicyName Nazwa zasad rejestracji. Dotyczy tylko dostawcy tożsamości usługi AAD B2C. struna

Ograniczenia:
Minimalna długość = 1
typ Identyfikator typu dostawcy tożsamości. "aad"
"aadB2C"
"facebook"
"google"
"microsoft"
"twitter"

Microsoft.ApiManagement/service/identityProviders

Nazwa Opis Wartość
nazwa Nazwa zasobu "aad"
"aadB2C"
"facebook"
"google"
"microsoft"
"twitter" (wymagane)
parent_id Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: usługi
Właściwości Właściwości kontraktu dostawcy tożsamości. IdentityProviderCreateContractPropertiesOrIdentityProviderContractProperties
typ Typ zasobu "Microsoft.ApiManagement/service/identityProviders@2021-01-01-preview"