Udostępnij za pośrednictwem


Microsoft.Web sites/sourcecontrols

Definicja zasobu Bicep

Typ zasobu lokacji/źródła 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.Web/sites/sourcecontrols, dodaj następujący kod Bicep do szablonu.

resource symbolicname 'Microsoft.Web/sites/sourcecontrols@2024-11-01' = {
  parent: resourceSymbolicName
  kind: 'string'
  name: 'web'
  properties: {
    branch: 'string'
    deploymentRollbackEnabled: bool
    gitHubActionConfiguration: {
      codeConfiguration: {
        runtimeStack: 'string'
        runtimeVersion: 'string'
      }
      containerConfiguration: {
        imageName: 'string'
        password: 'string'
        serverUrl: 'string'
        username: 'string'
      }
      generateWorkflowFile: bool
      isLinux: bool
    }
    isGitHubAction: bool
    isManualIntegration: bool
    isMercurial: bool
    repoUrl: 'string'
  }
}

Wartości właściwości

Microsoft.Web/sites/sourcecontrols

Nazwa Opis Wartość
rodzaj Rodzaj zasobu. struna
nazwa Nazwa zasobu "web" (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: witryny
Właściwości Właściwości specyficzne dla zasobu SiteSourceControl Właściwości SiteSourceControlProperties

GitHubActionCodeConfiguration

Nazwa Opis Wartość
runtimeStack (stos czasu uruchomieniowego) Stos środowiska uruchomieniowego służy do określania zawartości pliku przepływu pracy dla aplikacji bazowych kodu. struna
runtimeVersion (wersja uruchomieniowa) Wersja środowiska uruchomieniowego służy do określania wersji kompilacji ustawionej w pliku przepływu pracy. struna

GitHubActionConfiguration

Nazwa Opis Wartość
codeConfiguration (konfiguracja kodu) Konfiguracja kodu akcji usługi GitHub. GitHubActionCodeConfiguration
containerConfiguration (konfiguracja kontenera) Konfiguracja kontenera akcji usługi GitHub. GitHubActionContainerConfiguration
generateWorkflowFile (plik) Opcja przepływu pracy określająca, czy plik przepływu pracy powinien zostać wygenerowany i zapisany w repozytorium. Bool
isLinux (jest w systemie) Pomoże to określić konfigurację przepływu pracy do wybrania. Bool

GitHubActionContainerConfiguration

Nazwa Opis Wartość
imageName (nazwa_obrazu) Nazwa obrazu kompilacji. struna
hasło Hasło używane do przekazywania obrazu do rejestru kontenerów. struna

Ograniczenia:
Wartość wrażliwa. Przekaż jako bezpieczny parametr.
serverUrl (adres URL serwera) Adres URL serwera dla rejestru kontenerów, w którym będzie hostowana kompilacja. struna
nazwa użytkownika Nazwa użytkownika używana do przekazywania obrazu do rejestru kontenerów. struna

Właściwości SiteSourceControlProperties

Nazwa Opis Wartość
gałąź Nazwa gałęzi, która ma być używana do wdrożenia. struna
deploymentRollbackEnabled (wdrożenie) <kod>true</code> w celu włączenia wycofywania wdrożenia; w przeciwnym razie kod <>false</code>. Bool
gitHubActionConfiguration Jeśli wybrano akcję usługi GitHub, niż skojarzona konfiguracja. GitHubActionConfiguration
isGitHubAction (Akcja Sądu) <kod>true</code>, jeśli jest wdrożony za pośrednictwem akcji GitHub. Bool
isManualIntegration (Integracja z instrukcją) <kod>true</code> w celu ograniczenia integracji ręcznej; <kod>false</code> w celu włączenia ciągłej integracji (która konfiguruje elementy webhook w repozytoriach online, takich jak GitHub). Bool
isMercurial (rtęć) <kod>true</code> repozytorium Mercurial; <kod>false</code> dla repozytorium Git. Bool
repoUrl (adres URL repozytorium) Adres URL repozytorium lub kontroli źródła. struna

Przykłady użycia

Przykłady szybkiego startu platformy Azure

Poniższe szablony szybkiego startu platformy Azure zawierają przykłady Bicep na potrzeby wdrażania tego typu zasobu.

Plik Bicep Opis
Szybki start App Service — aplikacji systemu Linux Ten szablon ma być używany z szablonem /azure/app-service/quickstart-arm-template
Szybki start App Service — aplikacji systemu Windows Ten szablon ma być używany z szablonem /azure/app-service/quickstart-arm-template
Szybki start App Service — aplikacji systemu Windows Ten szablon ma być używany z szablonem /azure/app-service/quickstart-arm-template
Tworzenie bezobsługowego konta usługi Azure Cosmos i usługi Azure Web App Ten szablon tworzy konto usługi Azure Cosmos, wprowadza punkt końcowy i klucze usługi Cosmos DB do ustawień aplikacji internetowej platformy Azure, a następnie wdraża aplikację internetową ASP MVC z usługi GitHub.
wdrażanie aplikacji internetowej z usługi GitHub Ten szablon umożliwia utworzenie aplikacji internetowej połączonej z połączonym repozytorium GitHub.

Definicja zasobu szablonu usługi ARM

Typ zasobu lokacji/źródła 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.Web/sites/sourcecontrols, dodaj następujący kod JSON do szablonu.

{
  "type": "Microsoft.Web/sites/sourcecontrols",
  "apiVersion": "2024-11-01",
  "name": "string",
  "kind": "string",
  "properties": {
    "branch": "string",
    "deploymentRollbackEnabled": "bool",
    "gitHubActionConfiguration": {
      "codeConfiguration": {
        "runtimeStack": "string",
        "runtimeVersion": "string"
      },
      "containerConfiguration": {
        "imageName": "string",
        "password": "string",
        "serverUrl": "string",
        "username": "string"
      },
      "generateWorkflowFile": "bool",
      "isLinux": "bool"
    },
    "isGitHubAction": "bool",
    "isManualIntegration": "bool",
    "isMercurial": "bool",
    "repoUrl": "string"
  }
}

Wartości właściwości

Microsoft.Web/sites/sourcecontrols

Nazwa Opis Wartość
apiVersion (wersja interfejsu api) Wersja interfejsu API '2024-11-01'
rodzaj Rodzaj zasobu. struna
nazwa Nazwa zasobu "web" (wymagane)
Właściwości Właściwości specyficzne dla zasobu SiteSourceControl Właściwości SiteSourceControlProperties
typ Typ zasobu "Microsoft.Web/sites/sourcecontrols"

GitHubActionCodeConfiguration

Nazwa Opis Wartość
runtimeStack (stos czasu uruchomieniowego) Stos środowiska uruchomieniowego służy do określania zawartości pliku przepływu pracy dla aplikacji bazowych kodu. struna
runtimeVersion (wersja uruchomieniowa) Wersja środowiska uruchomieniowego służy do określania wersji kompilacji ustawionej w pliku przepływu pracy. struna

GitHubActionConfiguration

Nazwa Opis Wartość
codeConfiguration (konfiguracja kodu) Konfiguracja kodu akcji usługi GitHub. GitHubActionCodeConfiguration
containerConfiguration (konfiguracja kontenera) Konfiguracja kontenera akcji usługi GitHub. GitHubActionContainerConfiguration
generateWorkflowFile (plik) Opcja przepływu pracy określająca, czy plik przepływu pracy powinien zostać wygenerowany i zapisany w repozytorium. Bool
isLinux (jest w systemie) Pomoże to określić konfigurację przepływu pracy do wybrania. Bool

GitHubActionContainerConfiguration

Nazwa Opis Wartość
imageName (nazwa_obrazu) Nazwa obrazu kompilacji. struna
hasło Hasło używane do przekazywania obrazu do rejestru kontenerów. struna

Ograniczenia:
Wartość wrażliwa. Przekaż jako bezpieczny parametr.
serverUrl (adres URL serwera) Adres URL serwera dla rejestru kontenerów, w którym będzie hostowana kompilacja. struna
nazwa użytkownika Nazwa użytkownika używana do przekazywania obrazu do rejestru kontenerów. struna

Właściwości SiteSourceControlProperties

Nazwa Opis Wartość
gałąź Nazwa gałęzi, która ma być używana do wdrożenia. struna
deploymentRollbackEnabled (wdrożenie) <kod>true</code> w celu włączenia wycofywania wdrożenia; w przeciwnym razie kod <>false</code>. Bool
gitHubActionConfiguration Jeśli wybrano akcję usługi GitHub, niż skojarzona konfiguracja. GitHubActionConfiguration
isGitHubAction (Akcja Sądu) <kod>true</code>, jeśli jest wdrożony za pośrednictwem akcji GitHub. Bool
isManualIntegration (Integracja z instrukcją) <kod>true</code> w celu ograniczenia integracji ręcznej; <kod>false</code> w celu włączenia ciągłej integracji (która konfiguruje elementy webhook w repozytoriach online, takich jak GitHub). Bool
isMercurial (rtęć) <kod>true</code> repozytorium Mercurial; <kod>false</code> dla repozytorium Git. Bool
repoUrl (adres URL repozytorium) Adres URL repozytorium lub kontroli źródła. struna

Przykłady użycia

Szablony szybkiego startu platformy Azure

Następujące szablony szybkiego startu platformy Azure wdrożyć ten typ zasobu.

Szablon Opis
Szybki start App Service — aplikacji systemu Linux

wdrażanie w usłudze Azure
Ten szablon ma być używany z szablonem /azure/app-service/quickstart-arm-template
Szybki start App Service — aplikacji systemu Windows

wdrażanie w usłudze Azure
Ten szablon ma być używany z szablonem /azure/app-service/quickstart-arm-template
Szybki start App Service — aplikacji systemu Windows

wdrażanie w usłudze Azure
Ten szablon ma być używany z szablonem /azure/app-service/quickstart-arm-template
Tworzenie bezobsługowego konta usługi Azure Cosmos i usługi Azure Web App

wdrażanie w usłudze Azure
Ten szablon tworzy konto usługi Azure Cosmos, wprowadza punkt końcowy i klucze usługi Cosmos DB do ustawień aplikacji internetowej platformy Azure, a następnie wdraża aplikację internetową ASP MVC z usługi GitHub.
wdrażanie aplikacji internetowej z usługi GitHub

wdrażanie w usłudze Azure
Ten szablon umożliwia utworzenie aplikacji internetowej połączonej z połączonym repozytorium GitHub.

Definicja zasobu narzędzia Terraform (dostawcy AzAPI)

Typ zasobu lokacji/źródła 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.Web/sites/sourcecontrols, dodaj następujący program Terraform do szablonu.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Web/sites/sourcecontrols@2024-11-01"
  name = "string"
  parent_id = "string"
  body = {
    kind = "string"
    properties = {
      branch = "string"
      deploymentRollbackEnabled = bool
      gitHubActionConfiguration = {
        codeConfiguration = {
          runtimeStack = "string"
          runtimeVersion = "string"
        }
        containerConfiguration = {
          imageName = "string"
          password = "string"
          serverUrl = "string"
          username = "string"
        }
        generateWorkflowFile = bool
        isLinux = bool
      }
      isGitHubAction = bool
      isManualIntegration = bool
      isMercurial = bool
      repoUrl = "string"
    }
  }
}

Wartości właściwości

Microsoft.Web/sites/sourcecontrols

Nazwa Opis Wartość
rodzaj Rodzaj zasobu. struna
nazwa Nazwa zasobu "web" (wymagane)
parent_id (identyfikator rodzica) Identyfikator zasobu, który jest elementem nadrzędnym dla tego zasobu. Identyfikator zasobu typu: lokacje
Właściwości Właściwości specyficzne dla zasobu SiteSourceControl Właściwości SiteSourceControlProperties
typ Typ zasobu "Microsoft.Web/sites/sourcecontrols@2024-11-01"

GitHubActionCodeConfiguration

Nazwa Opis Wartość
runtimeStack (stos czasu uruchomieniowego) Stos środowiska uruchomieniowego służy do określania zawartości pliku przepływu pracy dla aplikacji bazowych kodu. struna
runtimeVersion (wersja uruchomieniowa) Wersja środowiska uruchomieniowego służy do określania wersji kompilacji ustawionej w pliku przepływu pracy. struna

GitHubActionConfiguration

Nazwa Opis Wartość
codeConfiguration (konfiguracja kodu) Konfiguracja kodu akcji usługi GitHub. GitHubActionCodeConfiguration
containerConfiguration (konfiguracja kontenera) Konfiguracja kontenera akcji usługi GitHub. GitHubActionContainerConfiguration
generateWorkflowFile (plik) Opcja przepływu pracy określająca, czy plik przepływu pracy powinien zostać wygenerowany i zapisany w repozytorium. Bool
isLinux (jest w systemie) Pomoże to określić konfigurację przepływu pracy do wybrania. Bool

GitHubActionContainerConfiguration

Nazwa Opis Wartość
imageName (nazwa_obrazu) Nazwa obrazu kompilacji. struna
hasło Hasło używane do przekazywania obrazu do rejestru kontenerów. struna

Ograniczenia:
Wartość wrażliwa. Przekaż jako bezpieczny parametr.
serverUrl (adres URL serwera) Adres URL serwera dla rejestru kontenerów, w którym będzie hostowana kompilacja. struna
nazwa użytkownika Nazwa użytkownika używana do przekazywania obrazu do rejestru kontenerów. struna

Właściwości SiteSourceControlProperties

Nazwa Opis Wartość
gałąź Nazwa gałęzi, która ma być używana do wdrożenia. struna
deploymentRollbackEnabled (wdrożenie) <kod>true</code> w celu włączenia wycofywania wdrożenia; w przeciwnym razie kod <>false</code>. Bool
gitHubActionConfiguration Jeśli wybrano akcję usługi GitHub, niż skojarzona konfiguracja. GitHubActionConfiguration
isGitHubAction (Akcja Sądu) <kod>true</code>, jeśli jest wdrożony za pośrednictwem akcji GitHub. Bool
isManualIntegration (Integracja z instrukcją) <kod>true</code> w celu ograniczenia integracji ręcznej; <kod>false</code> w celu włączenia ciągłej integracji (która konfiguruje elementy webhook w repozytoriach online, takich jak GitHub). Bool
isMercurial (rtęć) <kod>true</code> repozytorium Mercurial; <kod>false</code> dla repozytorium Git. Bool
repoUrl (adres URL repozytorium) Adres URL repozytorium lub kontroli źródła. struna