ApiPortals interface
Interfejs reprezentujący interfejs ApiPortals.
Metody
Szczegóły metody
beginCreateOrUpdate(string, string, string, ApiPortalResource, ApiPortalsCreateOrUpdateOptionalParams)
Utwórz domyślny portal interfejsu API lub zaktualizuj istniejący portal interfejsu API.
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiPortalName: string, apiPortalResource: ApiPortalResource, options?: ApiPortalsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiPortalResource>, ApiPortalResource>>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów zawierającej zasób. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager lub portalu.
- serviceName
-
string
Nazwa zasobu usługi.
- apiPortalName
-
string
Nazwa portalu interfejsu API.
- apiPortalResource
- ApiPortalResource
Portal interfejsu API dla operacji tworzenia lub aktualizowania
Parametry opcji.
Zwraca
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiPortalResource>, ApiPortalResource>>
beginCreateOrUpdateAndWait(string, string, string, ApiPortalResource, ApiPortalsCreateOrUpdateOptionalParams)
Utwórz domyślny portal interfejsu API lub zaktualizuj istniejący portal interfejsu API.
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiPortalName: string, apiPortalResource: ApiPortalResource, options?: ApiPortalsCreateOrUpdateOptionalParams): Promise<ApiPortalResource>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów zawierającej zasób. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager lub portalu.
- serviceName
-
string
Nazwa zasobu usługi.
- apiPortalName
-
string
Nazwa portalu interfejsu API.
- apiPortalResource
- ApiPortalResource
Portal interfejsu API dla operacji tworzenia lub aktualizowania
Parametry opcji.
Zwraca
Promise<ApiPortalResource>
beginDelete(string, string, string, ApiPortalsDeleteOptionalParams)
Usuń domyślny portal interfejsu API.
function beginDelete(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<void>, void>>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów zawierającej zasób. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager lub portalu.
- serviceName
-
string
Nazwa zasobu usługi.
- apiPortalName
-
string
Nazwa portalu interfejsu API.
- options
- ApiPortalsDeleteOptionalParams
Parametry opcji.
Zwraca
Promise<@azure/core-lro.SimplePollerLike<OperationState<void>, void>>
beginDeleteAndWait(string, string, string, ApiPortalsDeleteOptionalParams)
Usuń domyślny portal interfejsu API.
function beginDeleteAndWait(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsDeleteOptionalParams): Promise<void>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów zawierającej zasób. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager lub portalu.
- serviceName
-
string
Nazwa zasobu usługi.
- apiPortalName
-
string
Nazwa portalu interfejsu API.
- options
- ApiPortalsDeleteOptionalParams
Parametry opcji.
Zwraca
Promise<void>
get(string, string, string, ApiPortalsGetOptionalParams)
Pobierz portal interfejsu API i jego właściwości.
function get(resourceGroupName: string, serviceName: string, apiPortalName: string, options?: ApiPortalsGetOptionalParams): Promise<ApiPortalResource>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów zawierającej zasób. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager lub portalu.
- serviceName
-
string
Nazwa zasobu usługi.
- apiPortalName
-
string
Nazwa portalu interfejsu API.
- options
- ApiPortalsGetOptionalParams
Parametry opcji.
Zwraca
Promise<ApiPortalResource>
list(string, string, ApiPortalsListOptionalParams)
Obsługuje żądania, aby wyświetlić listę wszystkich zasobów w usłudze.
function list(resourceGroupName: string, serviceName: string, options?: ApiPortalsListOptionalParams): PagedAsyncIterableIterator<ApiPortalResource, ApiPortalResource[], PageSettings>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów zawierającej zasób. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager lub portalu.
- serviceName
-
string
Nazwa zasobu usługi.
- options
- ApiPortalsListOptionalParams
Parametry opcji.
Zwraca
validateDomain(string, string, string, CustomDomainValidatePayload, ApiPortalsValidateDomainOptionalParams)
Sprawdź, czy domeny są prawidłowe, jak również nie są używane.
function validateDomain(resourceGroupName: string, serviceName: string, apiPortalName: string, validatePayload: CustomDomainValidatePayload, options?: ApiPortalsValidateDomainOptionalParams): Promise<CustomDomainValidateResult>
Parametry
- resourceGroupName
-
string
Nazwa grupy zasobów zawierającej zasób. Tę wartość można uzyskać z interfejsu API usługi Azure Resource Manager lub portalu.
- serviceName
-
string
Nazwa zasobu usługi.
- apiPortalName
-
string
Nazwa portalu interfejsu API.
- validatePayload
- CustomDomainValidatePayload
Ładunek domeny niestandardowej do zweryfikowania
Parametry opcji.
Zwraca
Promise<CustomDomainValidateResult>