IdentityProvider interface
Interface die een IdentityProvider vertegenwoordigt.
Methoden
| create |
Hiermee maakt of Updates de IdentityProvider-configuratie. |
| delete(string, string, string, string, Identity |
Hiermee verwijdert u de configuratie van de opgegeven id-provider. |
| get(string, string, string, Identity |
Hiermee worden de configuratiedetails opgehaald van de id-provider die is geconfigureerd in het opgegeven service-exemplaar. |
| get |
Hiermee haalt u de versie van de entiteitsstatus (Etag) op van de identityProvider die is opgegeven door de id. |
| list |
Hiermee wordt een verzameling id-provider weergegeven die is geconfigureerd in het opgegeven service-exemplaar. |
| list |
Hiermee haalt u de details van het clientgeheim van de id-provider op. |
| update(string, string, string, string, Identity |
Updates een bestaande IdentityProvider-configuratie. |
Methodedetails
createOrUpdate(string, string, string, IdentityProviderCreateContract, IdentityProviderCreateOrUpdateOptionalParams)
Hiermee maakt of Updates de IdentityProvider-configuratie.
function createOrUpdate(resourceGroupName: string, serviceName: string, identityProviderName: string, parameters: IdentityProviderCreateContract, options?: IdentityProviderCreateOrUpdateOptionalParams): Promise<IdentityProviderCreateOrUpdateResponse>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- identityProviderName
-
string
Id van id-providertype.
- parameters
- IdentityProviderCreateContract
Parameters maken.
De optiesparameters.
Retouren
delete(string, string, string, string, IdentityProviderDeleteOptionalParams)
Hiermee verwijdert u de configuratie van de opgegeven id-provider.
function delete(resourceGroupName: string, serviceName: string, identityProviderName: string, ifMatch: string, options?: IdentityProviderDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- identityProviderName
-
string
Id van id-providertype.
- ifMatch
-
string
ETag van de entiteit. ETag moet overeenkomen met de huidige entiteitsstatus uit het headerantwoord van de GET-aanvraag of moet * zijn voor onvoorwaardelijke update.
De optiesparameters.
Retouren
Promise<void>
get(string, string, string, IdentityProviderGetOptionalParams)
Hiermee worden de configuratiedetails opgehaald van de id-provider die is geconfigureerd in het opgegeven service-exemplaar.
function get(resourceGroupName: string, serviceName: string, identityProviderName: string, options?: IdentityProviderGetOptionalParams): Promise<IdentityProviderGetResponse>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- identityProviderName
-
string
Id van id-providertype.
De optiesparameters.
Retouren
Promise<IdentityProviderGetResponse>
getEntityTag(string, string, string, IdentityProviderGetEntityTagOptionalParams)
Hiermee haalt u de versie van de entiteitsstatus (Etag) op van de identityProvider die is opgegeven door de id.
function getEntityTag(resourceGroupName: string, serviceName: string, identityProviderName: string, options?: IdentityProviderGetEntityTagOptionalParams): Promise<IdentityProviderGetEntityTagHeaders>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- identityProviderName
-
string
Id van id-providertype.
De optiesparameters.
Retouren
Promise<IdentityProviderGetEntityTagHeaders>
listByService(string, string, IdentityProviderListByServiceOptionalParams)
Hiermee wordt een verzameling id-provider weergegeven die is geconfigureerd in het opgegeven service-exemplaar.
function listByService(resourceGroupName: string, serviceName: string, options?: IdentityProviderListByServiceOptionalParams): PagedAsyncIterableIterator<IdentityProviderContract, IdentityProviderContract[], PageSettings>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
De optiesparameters.
Retouren
listSecrets(string, string, string, IdentityProviderListSecretsOptionalParams)
Hiermee haalt u de details van het clientgeheim van de id-provider op.
function listSecrets(resourceGroupName: string, serviceName: string, identityProviderName: string, options?: IdentityProviderListSecretsOptionalParams): Promise<IdentityProviderListSecretsResponse>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- identityProviderName
-
string
Id van id-providertype.
De optiesparameters.
Retouren
Promise<IdentityProviderListSecretsResponse>
update(string, string, string, string, IdentityProviderUpdateParameters, IdentityProviderUpdateOptionalParams)
Updates een bestaande IdentityProvider-configuratie.
function update(resourceGroupName: string, serviceName: string, identityProviderName: string, ifMatch: string, parameters: IdentityProviderUpdateParameters, options?: IdentityProviderUpdateOptionalParams): Promise<IdentityProviderUpdateResponse>Parameters
- resourceGroupName
-
string
De naam van de resourcegroep. De naam is niet hoofdlettergevoelig.
- serviceName
-
string
De naam van de API Management service.
- identityProviderName
-
string
Id van id-providertype.
- ifMatch
-
string
ETag van de entiteit. ETag moet overeenkomen met de huidige entiteitsstatus uit het headerantwoord van de GET-aanvraag of moet * zijn voor onvoorwaardelijke update.
- parameters
- IdentityProviderUpdateParameters
Parameters bijwerken.
De optiesparameters.
Retouren
Promise<IdentityProviderUpdateResponse>