Udostępnij przez


Azure Resource Manager

Usługa Azure Resource Manager uwidacznia interfejsy API do zarządzania wszystkimi zasobami platformy Azure.

Ten łącznik jest dostępny w następujących produktach i regionach:

Usługa Class Regions
Copilot Studio Premium Wszystkie regiony usługi Power Automate
Logic Apps Standard Wszystkie regiony usługi Logic Apps
Power Apps Premium Wszystkie regiony usługi Power Apps
Power Automate Premium Wszystkie regiony usługi Power Automate
Kontakt
Name Microsoft
adres URL Obsługa usługi Microsoft LogicApps
Pomoc techniczna usługi Microsoft Power Automate
Obsługa usługi Microsoft Power Apps
Metadane łącznika
Publisher Microsoft
Witryna internetowa https://azure.microsoft.com/features/resource-manager/

Znane problemy i ograniczenia

  • Jeśli wystąpi błąd z komunikatem "Nie można odnaleźć żadnego prawidłowego połączenia dla nazwy odwołania do połączenia "shared_office365" w nagłówku tokenów usługi APIM, możesz rozwiązać problemy, wykonując następujące czynności:
    • Wyczyść pamięć podręczną przeglądarki.
    • Usuń połączenie, a następnie dodaj je ponownie.
  • Akcja Wyświetlanie listy tagów zasobów subskrypcji może ściągnąć usunięte dane tagu z powodu ograniczeń w usłudze bazowej, która zarządza danymi tagów.
  • Zgodnie z projektem łącznik arm w usłudze Power Automate nie obsługuje bezpośrednich przypisań ról użytkownika dla wpisów tajnych usługi Azure Key Vault.

Tworzenie połączenia

Łącznik obsługuje następujące typy uwierzytelniania:

Wartość domyślna Parametry tworzenia połączenia. Wszystkie regiony Nie można udostępniać

Domyślny

Dotyczy: wszystkie regiony

Parametry tworzenia połączenia.

Nie jest to możliwe do udostępnienia połączenie. Jeśli aplikacja power zostanie udostępniona innemu użytkownikowi, zostanie wyświetlony monit o jawne utworzenie nowego połączenia.

Limity ograniczania

Nazwa Wywołania Okres odnowienia
Wywołania interfejsu API na połączenie 1200 60 sekund

Akcje

Aktualizowanie istniejącej grupy zasobów

Aktualizuje istniejącą grupę zasobów. Jeśli zasób nie istnieje, to żądanie zakończy się niepowodzeniem.

Anulowanie wdrożenia szablonu

Anuluj aktualnie uruchomione wdrożenie szablonu. Wszystkie oczekujące operacje szablonu zostaną zawieszone.

Eksportowanie szablonu grupy zasobów

Eksportuje szablon wdrożenia z istniejącej grupy zasobów. Może to zakończyć się powodzeniem tylko wtedy, gdy zasoby bazowe mają schemat zdefiniowany przez firmę Microsoft.

Eksportowanie szablonu wdrożenia

Eksportuje szablon z poprzedniego wdrożenia grupy zasobów.

Odczyt dostawcy zasobów

Odczytuje określonego dostawcę zasobów w ramach subskrypcji.

Odczytywanie grupy zasobów

Odczytuje określoną grupę zasobów w ramach subskrypcji.

Odczytywanie operacji wdrażania szablonu

Odczytuje określoną operację wdrażania szablonu grupy zasobów. Jest to przydatne w przypadku rozwiązywania problemów z nieudanymi wdrożeniami szablonów.

Odczytywanie subskrypcji

Odczytuje szczegóły dla określonej subskrypcji.

Odczytywanie wdrożenia szablonu

Odczytuje wdrożenie szablonu w grupie zasobów.

Odczytywanie zasobu

Odczytuje obiekt zasobu.

Odczytywanie zasobu u dostawcy

Odczytuje obiekt zasobu.

Rejestrowanie dostawcy zasobów

Rejestruje dostawcę zasobów do użycia z subskrypcją. Spowoduje to aprowizację uprawnień dla usługi w ramach subskrypcji.

Tworzenie lub aktualizowanie grupy zasobów

Tworzy lub aktualizuje grupę zasobów. Kod odpowiedzi może służyć do rozróżnienia między tworzeniem (201) lub aktualizacją (200).

Tworzenie lub aktualizowanie nazwy tagu zasobu subskrypcji

Utwórz lub zaktualizuj nazwę tagu zasobu subskrypcji.

Tworzenie lub aktualizowanie wartości tagu zasobu subskrypcji

Utwórz lub zaktualizuj wartość tagu zasobu subskrypcji.

Tworzenie lub aktualizowanie wdrożenia szablonu

Utwórz lub zaktualizuj nazwane wdrożenie szablonu grupy zasobów. Oczekuje się, że żądanie zakończy się pomyślnie, szablon i parametry.

Tworzenie lub aktualizowanie zasobu

Tworzy lub aktualizuje zasób. Kod odpowiedzi może służyć do rozróżnienia między tworzeniem (201) lub aktualizacją (200).

Usuwanie grupy zasobów

Usuń określoną grupę zasobów w ramach subskrypcji.

Usuwanie nazwy tagu zasobu subskrypcji

Usuń nazwę tagu zasobu subskrypcji.

Usuwanie wartości tagu zasobu subskrypcji

Usuń wartość tagu zasobu subskrypcji.

Usuwanie wdrożenia szablonu

Usuwa wdrożenie szablonu grupy zasobów. Zasoby nie zostaną usunięte; tylko metadane dotyczące wdrożenia szablonu.

Usuwanie zasobu

Usuwa zasób.

Weryfikowanie wdrożenia szablonu

Weryfikuje szablon wdrożenia. Ta operacja nie ma skutków ubocznych i może służyć do testowania wdrożenia szablonu pod kątem składni lub błędów logicznych.

Wyrejestrowywanie dostawcy zasobów

Wyrejestrowywanie dostawcy z subskrypcji. Ta operacja zakończy się niepowodzeniem, jeśli w subskrypcji znajdują się jakiekolwiek zasoby od tego dostawcy zasobów.

Wywoływanie operacji zasobu

Wywołuje operację na zasobie platformy Azure.

Wywoływanie operacji zasobu w dostawcy

Wywołuje operację na zasobie platformy Azure.

Wyświetla listę lokalizacji subskrypcji

Wyświetla listę lokalizacji dostępnych dla subskrypcji.

Wyświetla listę operacji wdrażania szablonu

Wyświetla listę wszystkich operacji wdrażania szablonu. Jest to przydatne w przypadku rozwiązywania problemów z nieudanymi wdrożeniami szablonów.

Wyświetlanie listy dostawców zasobów

Wyświetla listę dostawców zasobów dostępnych dla subskrypcji.

Wyświetlanie listy grup zasobów

Wyświetla listę wszystkich grup zasobów w ramach subskrypcji. Wyniki są podzielone na strony z 1000+ rekordów.

Wyświetlanie listy subskrypcji

Pobiera listę wszystkich subskrypcji, do których podmiot zabezpieczeń ma dostęp.

Wyświetlanie listy tagów zasobów subskrypcji

Wyświetla listę wszystkich tagów zasobów subskrypcji.

Wyświetlanie listy wdrożeń szablonów

Wyświetla listę wszystkich wdrożeń szablonu grupy zasobów. Ta operacja jest przydatna do poznania, co zostało do tej pory aprowidowane.

Wyświetlanie listy zasobów według grupy zasobów

Wyświetla listę wszystkich zasobów w grupie zasobów.

Wyświetlanie listy zasobów według subskrypcji

Odczytuje wszystkie zasoby w ramach określonej subskrypcji. Wyniki są podzielone na strony z 1000+ rekordów.

Aktualizowanie istniejącej grupy zasobów

Aktualizuje istniejącą grupę zasobów. Jeśli zasób nie istnieje, to żądanie zakończy się niepowodzeniem.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Grupa zasobów
resourceGroupName True string

Nazwa grupy zasobów.

Id
id string

Identyfikator grupy zasobów (np. /subscriptions/XXX/resourceGroups/RRRR).

Name
name string

Nazwa grupy zasobów.

Lokalizacja
location True string

Lokalizacja grupy zasobów. Nie można jej zmienić po utworzeniu grupy zasobów. Musi być jedną z obsługiwanych lokalizacji platformy Azure, takich jak Zachodnie stany USA, Wschodnie stany USA, Europa Zachodnia, Azja Wschodnia itp.

Zarządzane przez
managedBy string

Identyfikator zasobu, który zarządza tą grupą zasobów.

Etykiety
tags object

Tagi dołączone do grupy zasobów.

Stan inicjowania obsługi
provisioningState string

Stan aprowizacji.

Zwraca

Informacje o grupie zasobów.

Anulowanie wdrożenia szablonu

Anuluj aktualnie uruchomione wdrożenie szablonu. Wszystkie oczekujące operacje szablonu zostaną zawieszone.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Grupa zasobów
resourceGroupName True string

Nazwa grupy zasobów.

Nazwa wdrożenia
deploymentName True string

Nazwa wdrożenia szablonu grupy zasobów.

Eksportowanie szablonu grupy zasobów

Eksportuje szablon wdrożenia z istniejącej grupy zasobów. Może to zakończyć się powodzeniem tylko wtedy, gdy zasoby bazowe mają schemat zdefiniowany przez firmę Microsoft.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Grupa zasobów
resourceGroupName True string

Nazwa grupy zasobów.

resources
resources array of string

Identyfikatory zasobów. Jedynym obsługiwanym ciągiem jest obecnie "*" (wszystkie zasoby). Przyszłe aktualizacje interfejsu API będą obsługiwać eksportowanie określonych zasobów.

options
options string

Opcje szablonu eksportu. Obsługiwane wartości obejmują "IncludeParameterDefaultValue", "IncludeComments" lub "IncludeParameterDefaultValue, IncludeComments"

Zwraca

Eksportowanie szablonu wdrożenia

Eksportuje szablon z poprzedniego wdrożenia grupy zasobów.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Grupa zasobów
resourceGroupName True string

Nazwa grupy zasobów.

Nazwa wdrożenia
deploymentName True string

Nazwa wdrożenia szablonu grupy zasobów.

Zwraca

Wynik eksportu wdrożenia.

Odczyt dostawcy zasobów

Odczytuje określonego dostawcę zasobów w ramach subskrypcji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Dostawca zasobów
resourceProviderNamespace True string

Przestrzeń nazw dostawcy zasobów.

Rozwiń
$expand string

Parametr zapytania $expand.

Zwraca

Informacje o dostawcy zasobów.

Body
Provider

Odczytywanie grupy zasobów

Odczytuje określoną grupę zasobów w ramach subskrypcji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Grupa zasobów
resourceGroupName True string

Nazwa grupy zasobów.

Zwraca

Informacje o grupie zasobów.

Odczytywanie operacji wdrażania szablonu

Odczytuje określoną operację wdrażania szablonu grupy zasobów. Jest to przydatne w przypadku rozwiązywania problemów z nieudanymi wdrożeniami szablonów.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Grupa zasobów
resourceGroupName True string

Nazwa grupy zasobów.

Nazwa wdrożenia
deploymentName True string

Nazwa wdrożenia szablonu grupy zasobów.

Identyfikator operacji
operationId True string

Identyfikator operacji.

Zwraca

Informacje o operacji wdrażania.

Odczytywanie subskrypcji

Odczytuje szczegóły dla określonej subskrypcji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Zwraca

Informacje o subskrypcji.

Odczytywanie wdrożenia szablonu

Odczytuje wdrożenie szablonu w grupie zasobów.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Grupa zasobów
resourceGroupName True string

Nazwa grupy zasobów.

Nazwa wdrożenia
deploymentName True string

Nazwa wdrożenia szablonu grupy zasobów.

Oczekiwanie na wdrożenie
wait boolean

Jeśli akcja powinna poczekać na zakończenie wdrożenia

Zwraca

Informacje o wdrożeniu.

Odczytywanie zasobu

Odczytuje obiekt zasobu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Grupa zasobów
resourceGroupName True string

Nazwa grupy zasobów.

Dostawca zasobów
resourceProviderNamespace True string

Przestrzeń nazw dostawcy zasobów.

Krótki identyfikator zasobu
shortResourceId True string

Krótki identyfikator zasobu, w tym nazwa zasobu i typ zasobu. Na przykład witryny/moja witryna

Wersja interfejsu API klienta
x-ms-api-version True string

Wersja interfejsu API do użycia.

Zwraca

Informacje o zasobach.

Odczytywanie zasobu u dostawcy

Odczytuje obiekt zasobu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Dostawca zasobów
resourceProviderNamespace True string

Przestrzeń nazw dostawcy zasobów.

Krótki identyfikator zasobu
shortResourceId True string

Krótki identyfikator zasobu, w tym nazwa zasobu i typ zasobu. Na przykład witryny/moja witryna

Wersja interfejsu API klienta
x-ms-api-version True string

Wersja interfejsu API do użycia.

Zwraca

Informacje o zasobach.

Rejestrowanie dostawcy zasobów

Rejestruje dostawcę zasobów do użycia z subskrypcją. Spowoduje to aprowizację uprawnień dla usługi w ramach subskrypcji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Dostawca zasobów
resourceProviderNamespace True string

Przestrzeń nazw dostawcy zasobów.

Zwraca

Informacje o dostawcy zasobów.

Body
Provider

Tworzenie lub aktualizowanie grupy zasobów

Tworzy lub aktualizuje grupę zasobów. Kod odpowiedzi może służyć do rozróżnienia między tworzeniem (201) lub aktualizacją (200).

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Nazwa grupy zasobów
resourceGroupName True string

Nazwa grupy zasobów, która ma zostać utworzona lub zaktualizowana.

Id
id string

Identyfikator grupy zasobów (np. /subscriptions/XXX/resourceGroups/RRRR).

Name
name string

Nazwa grupy zasobów.

Lokalizacja
location True string

Lokalizacja grupy zasobów. Nie można jej zmienić po utworzeniu grupy zasobów. Musi być jedną z obsługiwanych lokalizacji platformy Azure, takich jak Zachodnie stany USA, Wschodnie stany USA, Europa Zachodnia, Azja Wschodnia itp.

Zarządzane przez
managedBy string

Identyfikator zasobu, który zarządza tą grupą zasobów.

Etykiety
tags object

Tagi dołączone do grupy zasobów.

Stan inicjowania obsługi
provisioningState string

Stan aprowizacji.

Zwraca

Informacje o grupie zasobów.

Tworzenie lub aktualizowanie nazwy tagu zasobu subskrypcji

Utwórz lub zaktualizuj nazwę tagu zasobu subskrypcji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Nazwa tagu
tagName True string

Nazwa znacznika.

Zwraca

Szczegóły tagu.

Body
TagDetails

Tworzenie lub aktualizowanie wartości tagu zasobu subskrypcji

Utwórz lub zaktualizuj wartość tagu zasobu subskrypcji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Nazwa tagu
tagName True string

Nazwa znacznika.

Wartość tagu
tagValue True string

Wartość tagu.

Zwraca

Informacje o tagach.

Body
TagValue

Tworzenie lub aktualizowanie wdrożenia szablonu

Utwórz lub zaktualizuj nazwane wdrożenie szablonu grupy zasobów. Oczekuje się, że żądanie zakończy się pomyślnie, szablon i parametry.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Grupa zasobów
resourceGroupName True string

Nazwa grupy zasobów.

Nazwa wdrożenia
deploymentName True string

Nazwa wdrożenia.

Zawartość szablonu
template object

Zawartość szablonu. Może to być ciąg JObject lub dobrze sformułowany ciąg JSON. Użyj tylko jednego szablonu lub szablonuLink.

Identyfikator URI szablonu
uri True string

Identyfikator URI odwołujący się do szablonu.

Wersja zawartości szablonu
contentVersion string

Jeśli go dołączono, musi być zgodny z elementem ContentVersion w szablonie.

Parametry
parameters object

Parametry wdrożenia. Może to być ciąg JObject lub dobrze sformułowany ciąg JSON. Użyj tylko jednego parametru lub parametruLink.

Identyfikator URI parametrów
uri True string

Identyfikator URI odwołujący się do szablonu.

Wersja zawartości parametrów
contentVersion string

Jeśli go dołączono, musi być zgodny z elementem ContentVersion w szablonie.

Tryb wdrażania
mode True string

Tryb wdrażania.

Poziom szczegółów
detailLevel string

Poziom szczegółów debugowania.

Oczekiwanie na wdrożenie
wait boolean

Jeśli akcja powinna poczekać na zakończenie wdrożenia

Zwraca

Informacje o wdrożeniu.

Tworzenie lub aktualizowanie zasobu

Tworzy lub aktualizuje zasób. Kod odpowiedzi może służyć do rozróżnienia między tworzeniem (201) lub aktualizacją (200).

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Grupa zasobów
resourceGroupName True string

Nazwa grupy zasobów.

Dostawca zasobów
resourceProviderNamespace True string

Przestrzeń nazw dostawcy zasobów.

Krótki identyfikator zasobu
shortResourceId True string

Krótki identyfikator zasobu, w tym nazwa zasobu i typ zasobu. Na przykład witryny/moja witryna

Wersja interfejsu API klienta
x-ms-api-version True string

Wersja interfejsu API do użycia.

Id
id string

Identyfikator zasobu

Name
name string

Nazwa zasobu

Typ
type string

Typ zasobu

Lokalizacja
location string

Lokalizacja zasobu

Etykiety
tags object

Tagi zasobów

Id
name string

Identyfikator planu.

Publisher
publisher string

Identyfikator wydawcy.

Product
product string

Identyfikator oferty.

Kod podwyższania poziomu
promotionCode string

Kod podwyższania poziomu.

Rodzaj
kind string

Rodzaj zasobu.

Zarządzane przez
managedBy string

Identyfikator zasobu, który zarządza tym zasobem.

Name
name string

Nazwa SKU.

Warstwa
tier string

Warstwa sku.

Rozmiar
size string

Rozmiar jednostki SKU.

Rodzina
family string

Rodzina jednostek SKU.

Model
model string

Model jednostki SKU.

Pojemność
capacity integer

Pojemność jednostki SKU.

Identyfikator podmiotu zabezpieczeń
principalId string

Identyfikator podmiotu zabezpieczeń tożsamości zasobu.

Identyfikator dzierżawcy
tenantId string

Identyfikator dzierżawy zasobu.

Typ
type string

Typ tożsamości.

Właściwości
properties object

Właściwości zasobu.

Zwraca

Informacje o zasobach.

Usuwanie grupy zasobów

Usuń określoną grupę zasobów w ramach subskrypcji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Grupa zasobów
resourceGroupName True string

Nazwa grupy zasobów.

Usuwanie nazwy tagu zasobu subskrypcji

Usuń nazwę tagu zasobu subskrypcji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Nazwa tagu
tagName True string

Nazwa znacznika.

Usuwanie wartości tagu zasobu subskrypcji

Usuń wartość tagu zasobu subskrypcji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Nazwa tagu
tagName True string

Nazwa znacznika.

Wartość tagu
tagValue True string

Wartość tagu.

Usuwanie wdrożenia szablonu

Usuwa wdrożenie szablonu grupy zasobów. Zasoby nie zostaną usunięte; tylko metadane dotyczące wdrożenia szablonu.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Grupa zasobów
resourceGroupName True string

Nazwa grupy zasobów.

Nazwa wdrożenia
deploymentName True string

Nazwa wdrożenia szablonu grupy zasobów.

Usuwanie zasobu

Usuwa zasób.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Grupa zasobów
resourceGroupName True string

Nazwa grupy zasobów.

Dostawca zasobów
resourceProviderNamespace True string

Przestrzeń nazw dostawcy zasobów.

Krótki identyfikator zasobu
shortResourceId True string

Krótki identyfikator zasobu, w tym nazwa zasobu i typ zasobu. Na przykład witryny/moja witryna

Wersja interfejsu API klienta
x-ms-api-version True string

Wersja interfejsu API do użycia.

Weryfikowanie wdrożenia szablonu

Weryfikuje szablon wdrożenia. Ta operacja nie ma skutków ubocznych i może służyć do testowania wdrożenia szablonu pod kątem składni lub błędów logicznych.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Grupa zasobów
resourceGroupName True string

Nazwa grupy zasobów.

Nazwa wdrożenia
deploymentName True string

Nazwa wdrożenia szablonu grupy zasobów.

Zawartość szablonu
template object

Zawartość szablonu. Może to być ciąg JObject lub dobrze sformułowany ciąg JSON. Użyj tylko jednego szablonu lub szablonuLink.

Identyfikator URI szablonu
uri True string

Identyfikator URI odwołujący się do szablonu.

Wersja zawartości szablonu
contentVersion string

Jeśli go dołączono, musi być zgodny z elementem ContentVersion w szablonie.

Parametry
parameters object

Parametry wdrożenia. Może to być ciąg JObject lub dobrze sformułowany ciąg JSON. Użyj tylko jednego parametru lub parametruLink.

Identyfikator URI parametrów
uri True string

Identyfikator URI odwołujący się do szablonu.

Wersja zawartości parametrów
contentVersion string

Jeśli go dołączono, musi być zgodny z elementem ContentVersion w szablonie.

Tryb wdrażania
mode True string

Tryb wdrażania.

Poziom szczegółów
detailLevel string

Poziom szczegółów debugowania.

Zwraca

Informacje z weryfikacji odpowiedzi wdrożenia szablonu.

Wyrejestrowywanie dostawcy zasobów

Wyrejestrowywanie dostawcy z subskrypcji. Ta operacja zakończy się niepowodzeniem, jeśli w subskrypcji znajdują się jakiekolwiek zasoby od tego dostawcy zasobów.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Dostawca zasobów
resourceProviderNamespace True string

Przestrzeń nazw dostawcy zasobów.

Zwraca

Informacje o dostawcy zasobów.

Body
Provider

Wywoływanie operacji zasobu

Wywołuje operację na zasobie platformy Azure.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Grupa zasobów
resourceGroupName True string

Nazwa grupy zasobów.

Dostawca zasobów
resourceProviderNamespace True string

Przestrzeń nazw dostawcy zasobów.

Krótki identyfikator zasobu
shortResourceId True string

Krótki identyfikator zasobu, w tym nazwa zasobu i typ zasobu. Na przykład witryny/moja witryna

Wersja interfejsu API klienta
x-ms-api-version True string

Wersja interfejsu API do użycia.

Nazwa akcji
actionName True string

Nazwa akcji zasobu do wywołania

Zwraca

Odpowiedź z operacji akcji.

Odpowiedź na akcję
object

Wywoływanie operacji zasobu w dostawcy

Wywołuje operację na zasobie platformy Azure.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Dostawca zasobów
resourceProviderNamespace True string

Przestrzeń nazw dostawcy zasobów.

Krótki identyfikator zasobu
shortResourceId True string

Krótki identyfikator zasobu, w tym nazwa zasobu i typ zasobu. Na przykład witryny/moja witryna

Wersja interfejsu API klienta
x-ms-api-version True string

Wersja interfejsu API do użycia.

Zwraca

Odpowiedź z operacji.

Odpowiedź
object

Wyświetla listę lokalizacji subskrypcji

Wyświetla listę lokalizacji dostępnych dla subskrypcji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Zwraca

Odpowiedź operacji listy lokalizacji.

Wyświetla listę operacji wdrażania szablonu

Wyświetla listę wszystkich operacji wdrażania szablonu. Jest to przydatne w przypadku rozwiązywania problemów z nieudanymi wdrożeniami szablonów.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Grupa zasobów
resourceGroupName True string

Nazwa grupy zasobów.

Nazwa wdrożenia
deploymentName True string

Nazwa wdrożenia szablonu grupy zasobów.

Do góry
$top integer

Parametry zapytania. Jeśli nic nie zostanie przekazane, zwraca wszystkie wartości.

Zwraca

Lista operacji wdrażania.

Wyświetlanie listy dostawców zasobów

Wyświetla listę dostawców zasobów dostępnych dla subskrypcji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Do góry
$top integer

Parametry zapytania. Jeśli nic nie zostanie przekazane, zwraca wszystkie wartości.

Rozwiń
$expand string

Parametr zapytania $expand.

Zwraca

Lista dostawców zasobów.

Wyświetlanie listy grup zasobów

Wyświetla listę wszystkich grup zasobów w ramach subskrypcji. Wyniki są podzielone na strony z 1000+ rekordów.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Filter
$filter string

Filtr do zastosowania w operacji.

Do góry
$top integer

Parametry zapytania. Jeśli nic nie zostanie przekazane, zwraca wszystkie wartości.

Zwraca

Lista grup zasobów.

Wyświetlanie listy subskrypcji

Pobiera listę wszystkich subskrypcji, do których podmiot zabezpieczeń ma dostęp.

Zwraca

Odpowiedź na operację listy subskrypcji.

Wyświetlanie listy tagów zasobów subskrypcji

Wyświetla listę wszystkich tagów zasobów subskrypcji.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Zwraca

Lista tagów subskrypcji.

Wyświetlanie listy wdrożeń szablonów

Wyświetla listę wszystkich wdrożeń szablonu grupy zasobów. Ta operacja jest przydatna do poznania, co zostało do tej pory aprowidowane.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Grupa zasobów
resourceGroupName True string

Nazwa grupy zasobów.

Filter
$filter string

Filtr do zastosowania w operacji.

Do góry
$top integer

Parametry zapytania. Jeśli nic nie zostanie przekazane, zwraca wszystkie wartości.

Zwraca

Lista wdrożeń.

Wyświetlanie listy zasobów według grupy zasobów

Wyświetla listę wszystkich zasobów w grupie zasobów.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Grupa zasobów
resourceGroupName True string

Nazwa grupy zasobów.

Filter
$filter string

Filtr do zastosowania w operacji.

Rozwiń
$expand string

Parametr zapytania $expand.

Do góry
$top integer

Parametry zapytania. Jeśli nic nie zostanie przekazane, zwraca wszystkie wartości.

Zwraca

Lista zasobów.

Wyświetlanie listy zasobów według subskrypcji

Odczytuje wszystkie zasoby w ramach określonej subskrypcji. Wyniki są podzielone na strony z 1000+ rekordów.

Parametry

Nazwa Klucz Wymagane Typ Opis
Subscription
subscriptionId True string

Unikatowy identyfikator subskrypcji platformy Microsoft Azure. Identyfikator subskrypcji stanowi część identyfikatora dla każdego zasobu platformy Azure.

Filter
$filter string

Filtr do zastosowania w operacji.

Rozwiń
$expand string

Parametr zapytania $expand.

Do góry
$top integer

Parametry zapytania. Jeśli nic nie zostanie przekazane, zwraca wszystkie wartości.

Zwraca

Lista zasobów.

Definicje

Lokalizacja

Informacje o lokalizacji.

Nazwa Ścieżka Typ Opis
Id
id string

W pełni kwalifikowany identyfikator lokalizacji. Na przykład /subscriptions/000000000-0000-0000-0000-00000000000000/locations/westus.

Identyfikator subskrypcji
subscriptionId string

Identyfikator subskrypcji.

Nazwa lokalizacji
name string

Nazwa lokalizacji.

Wyświetlana nazwa
displayName string

Nazwa wyświetlana lokalizacji.

Szerokość
latitude string

Szerokość geograficzna lokalizacji.

Długość
longitude string

Długość geograficzna lokalizacji.

LocationListResult

Odpowiedź operacji listy lokalizacji.

Nazwa Ścieżka Typ Opis
value
value array of Location

Lokalizacje.

Subscription

Informacje o subskrypcji.

Nazwa Ścieżka Typ Opis
Id
id string

W pełni kwalifikowany identyfikator. Na przykład /subscriptions/000000000-0000-0000-0000-00000000000000000.

Identyfikator subskrypcji
subscriptionId string

Identyfikator subskrypcji.

Identyfikator dzierżawcy
tenantId string

Identyfikator dzierżawy.

Wyświetlana nazwa
displayName string

Nazwa wyświetlana subskrypcji.

State
state string

Stan subskrypcji.

Zasady subskrypcji
subscriptionPolicies SubscriptionPolicies

Zasady subskrypcji.

Źródło autoryzacji
authorizationSource string

Źródło autoryzacji żądania. Prawidłowe wartości to co najmniej jedna kombinacja starszej wersji, RoleBased, Pomijane, Bezpośrednie i Zarządzanie. Na przykład "Starsza wersja, RolaBased".

SubskrypcjaZasady

Zasady subskrypcji.

Nazwa Ścieżka Typ Opis
Identyfikator umieszczania lokalizacji
locationPlacementId string

Identyfikator umieszczania lokalizacji subskrypcji. Identyfikator wskazuje, które regiony są widoczne dla subskrypcji. Na przykład subskrypcja z identyfikatorem umieszczania lokalizacji Public_2014-09-01 ma dostęp do regionów publicznych platformy Azure.

Identyfikator limitu przydziału
quotaId string

Identyfikator limitu przydziału subskrypcji.

Limit wydatków
spendingLimit string

Limit wydatków subskrypcji.

SubscriptionListResult

Odpowiedź na operację listy subskrypcji.

Nazwa Ścieżka Typ Opis
value
value array of Subscription

Subskrypcje.

Następny link
nextLink string

Adres URL, aby uzyskać następny zestaw wyników.

Jednostka reprezentująca odwołanie do szablonu.

Nazwa Ścieżka Typ Opis
Identyfikator URI szablonu
uri string

Identyfikator URI odwołujący się do szablonu.

Wersja zawartości szablonu
contentVersion string

Jeśli go dołączono, musi być zgodny z elementem ContentVersion w szablonie.

Jednostka reprezentująca odwołanie do parametrów wdrożenia.

Nazwa Ścieżka Typ Opis
Identyfikator URI parametrów
uri string

Identyfikator URI odwołujący się do szablonu.

Wersja zawartości parametrów
contentVersion string

Jeśli go dołączono, musi być zgodny z elementem ContentVersion w szablonie.

DebugOwanie

Nazwa Ścieżka Typ Opis
Poziom szczegółów
detailLevel string

Poziom szczegółów debugowania.

DeploymentExportResult

Wynik eksportu wdrożenia.

Nazwa Ścieżka Typ Opis
Template
template object

Zawartość szablonu.

ResourceManagementErrorWithDetails

Nazwa Ścieżka Typ Opis
kod
code string

Kod błędu zwrócony z serwera.

komunikat
message string

Komunikat o błędzie zwrócony z serwera.

miejsce docelowe
target string

Element docelowy błędu.

details
details array of object

Błąd weryfikacji.

AliasPathType

Typ ścieżek dla aliasu.

Nazwa Ścieżka Typ Opis
ścieżka
path string

Ścieżka aliasu.

apiVersions (wersje api)
apiVersions array of string

Wersje interfejsu API.

AliasType

Typ aliasu.

Nazwa Ścieżka Typ Opis
nazwa
name string

Nazwa aliasu.

Ścieżki
paths array of AliasPathType

Ścieżki aliasu.

ProviderResourceType

Typ zasobu zarządzany przez dostawcę zasobów.

Nazwa Ścieżka Typ Opis
resourceType
resourceType string

Typ zasobu.

lokalizacje
locations array of ObjectWithoutType

Kolekcja lokalizacji, w których można utworzyć ten typ zasobu.

aliases
aliases array of AliasType

Aliasy obsługiwane przez ten typ zasobu.

apiVersions (wersje api)
apiVersions array of string

Wersja interfejsu API.

properties
properties object

Właściwości.

Provider

Informacje o dostawcy zasobów.

Nazwa Ścieżka Typ Opis
Id
id string

Identyfikator dostawcy.

Namespace
namespace string

Przestrzeń nazw dostawcy.

Stan rejestracji
registrationState string

Stan rejestracji dostawcy.

Typ zasobu
resourceTypes array of ProviderResourceType

Kolekcja typów zasobów dostawcy.

Podstawowa Współzależność

Informacje o zależnościach wdrożenia.

Nazwa Ścieżka Typ Opis
id
id string

Identyfikator zależności.

resourceType
resourceType string

Typ zasobu zależności.

resourceName
resourceName string

Nazwa zasobu zależności.

Zależność

Informacje o zależnościach wdrożenia.

Nazwa Ścieżka Typ Opis
dependsOn
dependsOn array of BasicDependency

Lista zależności.

id
id string

Identyfikator zależności.

resourceType
resourceType string

Typ zasobu zależności.

resourceName
resourceName string

Nazwa zasobu zależności.

DeploymentPropertiesExtended

Właściwości wdrożenia z dodatkowymi szczegółami.

Nazwa Ścieżka Typ Opis
provisioningState
provisioningState string

Stan aprowizacji.

correlationId (identyfikator korelacji)
correlationId string

Identyfikator korelacji wdrożenia.

sygnatura czasowa
timestamp date-time

Sygnatura czasowa wdrożenia szablonu.

Wyniki
outputs object

Pary klucz/wartość reprezentujące wartość wdrożenia.

providers
providers array of Provider

Lista dostawców zasobów wymaganych do wdrożenia.

zależności
dependencies array of Dependency

Lista zależności wdrożenia.

szablon
template object

Zawartość szablonu. Użyj tylko jednego szablonu lub szablonuLink.

templateLink (link do szablonu)
templateLink TemplateLink

Jednostka reprezentująca odwołanie do szablonu.

parameters
parameters object

Parametry wdrożenia. Użyj tylko jednego parametru lub parametruLink.

parametryLink
parametersLink ParametersLink

Jednostka reprezentująca odwołanie do parametrów wdrożenia.

Tryb wdrażania
mode string

Tryb wdrażania.

debugSetting (ustawienie debug)
debugSetting DebugSetting

DeploymentValidateResult

Informacje z weryfikacji odpowiedzi wdrożenia szablonu.

Nazwa Ścieżka Typ Opis
błąd
error ResourceManagementErrorWithDetails
properties
properties DeploymentPropertiesExtended

Właściwości wdrożenia z dodatkowymi szczegółami.

WdrożenieExtended

Informacje o wdrożeniu.

Nazwa Ścieżka Typ Opis
Id
id string

Identyfikator wdrożenia.

Name
name string

Nazwa wdrożenia.

properties
properties DeploymentPropertiesExtended

Właściwości wdrożenia z dodatkowymi szczegółami.

DeploymentListResult

Lista wdrożeń.

Nazwa Ścieżka Typ Opis
value
value array of DeploymentExtended

Lista wdrożeń.

Następny link
nextLink string

Adres URL, aby uzyskać następny zestaw wyników.

ProviderListResult

Lista dostawców zasobów.

Nazwa Ścieżka Typ Opis
value
value array of Provider

Lista dostawców zasobów.

nextLink
nextLink string

Adres URL, aby uzyskać następny zestaw wyników.

GenericResource

Informacje o zasobach.

Nazwa Ścieżka Typ Opis
Id
id string

Identyfikator zasobu

Name
name string

Nazwa zasobu

Typ
type string

Typ zasobu

Lokalizacja
location string

Lokalizacja zasobu

Etykiety
tags object

Tagi zasobów

plan
plan Plan

Zaplanuj zasób.

Rodzaj
kind string

Rodzaj zasobu.

Zarządzane przez
managedBy string

Identyfikator zasobu, który zarządza tym zasobem.

SKU
sku Sku

Jednostka SKU zasobu.

Tożsamość
identity Identity

Tożsamość zasobu.

Właściwości
properties object

Właściwości zasobu.

Plan

Zaplanuj zasób.

Nazwa Ścieżka Typ Opis
Id
name string

Identyfikator planu.

Publisher
publisher string

Identyfikator wydawcy.

Product
product string

Identyfikator oferty.

Kod podwyższania poziomu
promotionCode string

Kod podwyższania poziomu.

Sku

Jednostka SKU zasobu.

Nazwa Ścieżka Typ Opis
Name
name string

Nazwa SKU.

Warstwa
tier string

Warstwa sku.

Rozmiar
size string

Rozmiar jednostki SKU.

Rodzina
family string

Rodzina jednostek SKU.

Model
model string

Model jednostki SKU.

Pojemność
capacity integer

Pojemność jednostki SKU.

Tożsamość

Tożsamość zasobu.

Nazwa Ścieżka Typ Opis
Identyfikator podmiotu zabezpieczeń
principalId string

Identyfikator podmiotu zabezpieczeń tożsamości zasobu.

Identyfikator dzierżawcy
tenantId string

Identyfikator dzierżawy zasobu.

Typ
type string

Typ tożsamości.

ResourceListResult

Lista zasobów.

Nazwa Ścieżka Typ Opis
value
value array of GenericResource

Lista zasobów.

Następny link
nextLink string

Adres URL, aby uzyskać następny zestaw wyników.

Grupa zasobów

Informacje o grupie zasobów.

Nazwa Ścieżka Typ Opis
Id
id string

Identyfikator grupy zasobów (np. /subscriptions/XXX/resourceGroups/RRRR).

Name
name string

Nazwa grupy zasobów.

Lokalizacja
location string

Lokalizacja grupy zasobów. Nie można jej zmienić po utworzeniu grupy zasobów. Musi być jedną z obsługiwanych lokalizacji platformy Azure, takich jak Zachodnie stany USA, Wschodnie stany USA, Europa Zachodnia, Azja Wschodnia itp.

Zarządzane przez
managedBy string

Identyfikator zasobu, który zarządza tą grupą zasobów.

Etykiety
tags object

Tagi dołączone do grupy zasobów.

properties
properties ResourceGroupProperties

Właściwości grupy zasobów.

Właściwości grupy zasobów

Właściwości grupy zasobów.

Nazwa Ścieżka Typ Opis
Stan inicjowania obsługi
provisioningState string

Stan aprowizacji.

ResourceGroupListResult

Lista grup zasobów.

Nazwa Ścieżka Typ Opis
value
value array of ResourceGroup

Lista grup zasobów.

Następny link
nextLink string

Adres URL, aby uzyskać następny zestaw wyników.

TagCount

Liczba tagów.

Nazwa Ścieżka Typ Opis
Typ
type string

Typ liczby.

Wartość
value integer

Wartość liczby.

TagValue

Informacje o tagach.

Nazwa Ścieżka Typ Opis
Identyfikator tagu
id string

Identyfikator tagu.

Wartość tagu
tagValue string

Wartość tagu.

Liczba tagów
count TagCount

Liczba tagów.

TagDetails

Szczegóły tagu.

Nazwa Ścieżka Typ Opis
Id
id string

Identyfikator tagu.

Name
tagName string

Nazwa tagu.

Liczba tagów
count TagCount

Liczba tagów.

values
values array of TagValue

Lista wartości tagów.

TagsListResult

Lista tagów subskrypcji.

Nazwa Ścieżka Typ Opis
value
value array of TagDetails

Lista tagów.

nextLink
nextLink string

Adres URL, aby uzyskać następny zestaw wyników.

TargetResource

Zasób docelowy.

Nazwa Ścieżka Typ Opis
Id
id string

Identyfikator zasobu.

Name
resourceName string

Nazwa zasobu.

Typ
resourceType string

Typ zasobu.

HttpMessage

Nazwa Ścieżka Typ Opis
zawartość
content object

Zawartość komunikatu HTTP.

DeploymentOperationProperties

Właściwości operacji wdrażania.

Nazwa Ścieżka Typ Opis
provisioningState
provisioningState string

Stan aprowizacji.

sygnatura czasowa
timestamp date-time

Data i godzina operacji.

serviceRequestId
serviceRequestId string

Identyfikator żądania obsługi operacji wdrożenia.

kod statusu
statusCode string

Kod stanu operacji.

Komunikat o statusie
statusMessage object

Komunikat o stanie operacji.

Zasób docelowy
targetResource TargetResource

Zasób docelowy.

żądanie
request HttpMessage
response
response HttpMessage

DeploymentOperation

Informacje o operacji wdrażania.

Nazwa Ścieżka Typ Opis
Id
id string

Identyfikator pełnej operacji wdrażania.

Identyfikator operacji
operationId string

Identyfikator operacji wdrożenia.

properties
properties DeploymentOperationProperties

Właściwości operacji wdrażania.

DeploymentOperationsListResult

Lista operacji wdrażania.

Nazwa Ścieżka Typ Opis
value
value array of DeploymentOperation

Lista wdrożeń.

Następny link
nextLink string

Adres URL, aby uzyskać następny zestaw wyników.

ResourceGroupExportResult

Nazwa Ścieżka Typ Opis
Template
template object

Zawartość szablonu.

błąd
error ResourceManagementErrorWithDetails

ObjectWithoutType

obiekt

Jest to typ 'obiekt'.